Close httplib2 connections.
generate(parent, body=None, x__xgafv=None)
Generates an AdMob mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
+Generates an AdMob Mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
close()
@@ -88,14 +88,14 @@ generate(parent, body=None, x__xgafv=None)
- Generates an AdMob mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
+ Generates an AdMob Mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
Args:
parent: string, Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 (required)
body: object, The request body.
The object takes the form of:
-{ # Request to generate an AdMob mediation report.
+{ # Request to generate an AdMob Mediation report.
"reportSpec": { # The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { "date_range": { "start_date": {"year": 2021, "month": 9, "day": 1}, "end_date": {"year": 2021, "month": 9, "day": 30} }, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "metrics": ["OBSERVED_ECPM"], "dimension_filters": [ { "dimension": "COUNTRY", "matches_any": {"values": [{"value": "US", "value": "CN"}]} } ], "sort_conditions": [ {"dimension":"APP", order: "ASCENDING"} ], "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC; # Network report specification.
"dateRange": { # Specification of a single date range. Both dates are inclusive. # The date range for which the report is generated.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End date of the date range, inclusive. Must be greater than or equal to the start date.
@@ -149,7 +149,7 @@ Method Details
Returns:
An object of the form:
- { # The streaming response for the AdMob mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ "header": { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 1} }, "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } }, { "row": { "dimension_values": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", "display_label": "My app name!" } }, "metric_values": { "ESTIMATED_EARNINGS": {"decimal_value": "1324746"} } } }, { "footer": {"matching_row_count": 1} }]
+ { # The streaming response for the AdMob Mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ "header": { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 1} }, "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } }, { "row": { "dimension_values": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", "display_label": "My app name!" } }, "metric_values": { "ESTIMATED_EARNINGS": {"decimal_value": "1324746"} } } }, { "footer": {"matching_row_count": 1} }]
"footer": { # Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response. # Additional information about the generated report, such as warnings about the data.
"matchingRowCount": "A String", # Total number of rows that matched the request. Warning: This count does NOT always match the number of rows in the response. Do not make that assumption when processing the response.
"warnings": [ # Warnings associated with generation of the report.
diff --git a/docs/dyn/admob_v1beta.accounts.mediationGroups.html b/docs/dyn/admob_v1beta.accounts.mediationGroups.html
index 81bf287424e..46bda6473c2 100644
--- a/docs/dyn/admob_v1beta.accounts.mediationGroups.html
+++ b/docs/dyn/admob_v1beta.accounts.mediationGroups.html
@@ -109,7 +109,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # Describes an AdMob mediation group.
+{ # Describes an AdMob Mediation group.
"displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters.
"mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group.
"mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property.
@@ -153,7 +153,7 @@ Method Details
Returns:
An object of the form:
- { # Describes an AdMob mediation group.
+ { # Describes an AdMob Mediation group.
"displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters.
"mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group.
"mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property.
@@ -209,7 +209,7 @@ Method Details
{ # Response for the mediation groups list request.
"mediationGroups": [ # The resulting mediation groups for the requested account.
- { # Describes an AdMob mediation group.
+ { # Describes an AdMob Mediation group.
"displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters.
"mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group.
"mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property.
@@ -272,7 +272,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # Describes an AdMob mediation group.
+{ # Describes an AdMob Mediation group.
"displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters.
"mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group.
"mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property.
@@ -317,7 +317,7 @@ Method Details
Returns:
An object of the form:
- { # Describes an AdMob mediation group.
+ { # Describes an AdMob Mediation group.
"displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters.
"mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group.
"mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property.
diff --git a/docs/dyn/admob_v1beta.accounts.mediationReport.html b/docs/dyn/admob_v1beta.accounts.mediationReport.html
index 71d484d58e4..8b057dbcb6c 100644
--- a/docs/dyn/admob_v1beta.accounts.mediationReport.html
+++ b/docs/dyn/admob_v1beta.accounts.mediationReport.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
generate(parent, body=None, x__xgafv=None)
-Generates an AdMob mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
+Generates an AdMob Mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
Method Details
close()
@@ -88,14 +88,14 @@ Method Details
generate(parent, body=None, x__xgafv=None)
- Generates an AdMob mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
+ Generates an AdMob Mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
Args:
parent: string, Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 (required)
body: object, The request body.
The object takes the form of:
-{ # Request to generate an AdMob mediation report.
+{ # Request to generate an AdMob Mediation report.
"reportSpec": { # The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { "date_range": { "start_date": {"year": 2021, "month": 9, "day": 1}, "end_date": {"year": 2021, "month": 9, "day": 30} }, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "metrics": ["OBSERVED_ECPM"], "dimension_filters": [ { "dimension": "COUNTRY", "matches_any": {"values": [{"value": "US", "value": "CN"}]} } ], "sort_conditions": [ {"dimension":"APP", order: "ASCENDING"} ], "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC; # Network report specification.
"dateRange": { # Specification of a single date range. Both dates are inclusive. # The date range for which the report is generated.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # End date of the date range, inclusive. Must be greater than or equal to the start date.
@@ -149,7 +149,7 @@ Method Details
Returns:
An object of the form:
- { # The streaming response for the AdMob mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ "header": { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 1} }, "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } }, { "row": { "dimension_values": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", "display_label": "My app name!" } }, "metric_values": { "ESTIMATED_EARNINGS": {"decimal_value": "1324746"} } } }, { "footer": {"matching_row_count": 1} }]
+ { # The streaming response for the AdMob Mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ "header": { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 1} }, "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } }, { "row": { "dimension_values": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", "display_label": "My app name!" } }, "metric_values": { "ESTIMATED_EARNINGS": {"decimal_value": "1324746"} } } }, { "footer": {"matching_row_count": 1} }]
"footer": { # Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response. # Additional information about the generated report, such as warnings about the data.
"matchingRowCount": "A String", # Total number of rows that matched the request. Warning: This count does NOT always match the number of rows in the response. Do not make that assumption when processing the response.
"warnings": [ # Warnings associated with generation of the report.
diff --git a/docs/dyn/adsense_v2.accounts.policyIssues.html b/docs/dyn/adsense_v2.accounts.policyIssues.html
index b9b8efd68bf..3ae7df3f261 100644
--- a/docs/dyn/adsense_v2.accounts.policyIssues.html
+++ b/docs/dyn/adsense_v2.accounts.policyIssues.html
@@ -82,7 +82,7 @@ Instance Methods
Gets information about the selected policy issue.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-Lists all the policy issues for the specified account.
+Lists all the policy issues where the specified account is involved, both directly and through any AFP child accounts.
Retrieves the next page of results.
@@ -143,7 +143,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- Lists all the policy issues for the specified account.
+ Lists all the policy issues where the specified account is involved, both directly and through any AFP child accounts.
Args:
parent: string, Required. The account for which policy issues are being retrieved. Format: accounts/{account} (required)
diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html
index 177454c6816..512a521a79b 100644
--- a/docs/dyn/analyticsadmin_v1alpha.accounts.html
+++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html
@@ -563,6 +563,7 @@ Method Details
},
"audience": { # A resource message representing a GA4 Audience. # A snapshot of an Audience resource in change history.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
@@ -1044,6 +1045,7 @@ Method Details
},
"audience": { # A resource message representing a GA4 Audience. # A snapshot of an Audience resource in change history.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html b/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html
index ac0ec57627f..c5bdbfc0274 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html
@@ -136,6 +136,7 @@ Method Details
{ # A resource message representing a GA4 Audience.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
@@ -276,6 +277,7 @@ Method Details
{ # A resource message representing a GA4 Audience.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
@@ -423,6 +425,7 @@ Method Details
{ # A resource message representing a GA4 Audience.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
@@ -574,6 +577,7 @@ Method Details
"audiences": [ # List of Audiences.
{ # A resource message representing a GA4 Audience.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
@@ -733,6 +737,7 @@ Method Details
{ # A resource message representing a GA4 Audience.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
@@ -874,6 +879,7 @@ Method Details
{ # A resource message representing a GA4 Audience.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
+ "createTime": "A String", # Output only. Time when the Audience was created.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html
index 35fc0d6e39e..8e49670057d 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.html
@@ -417,7 +417,6 @@ Method Details
The object takes the form of:
{ # Request message for CreateSubproperty RPC.
- "parent": "A String", # Required. The ordinary property for which to create a subproperty. Format: properties/property_id Example: properties/123
"subproperty": { # A resource message representing a Google Analytics GA4 property. # Required. The subproperty to create.
"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
"createTime": "A String", # Output only. Time when the entity was originally created.
diff --git a/docs/dyn/androidmanagement_v1.provisioningInfo.html b/docs/dyn/androidmanagement_v1.provisioningInfo.html
index 5f49629ca10..d60459bf6ca 100644
--- a/docs/dyn/androidmanagement_v1.provisioningInfo.html
+++ b/docs/dyn/androidmanagement_v1.provisioningInfo.html
@@ -104,13 +104,13 @@ Method Details
"apiLevel": 42, # The API level of the Android platform version running on the device.
"brand": "A String", # The brand of the device. For example, Google.
"enterprise": "A String", # The name of the enterprise in the form enterprises/{enterprise}.
- "imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
+ "imei": "A String", # For corporate-owned devices, IMEI number of the GSM device. For example, A1000031212.
"managementMode": "A String", # The management mode of the device or profile.
- "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
+ "meid": "A String", # For corporate-owned devices, MEID number of the CDMA device. For example, A00000292788E1.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"name": "A String", # The name of this resource in the form provisioningInfo/{provisioning_info}.
"ownership": "A String", # Ownership of the managed device.
- "serialNumber": "A String", # The device serial number.
+ "serialNumber": "A String", # For corporate-owned devices, The device serial number.
}
diff --git a/docs/dyn/androidmanagement_v1.signupUrls.html b/docs/dyn/androidmanagement_v1.signupUrls.html
index b2bf21d06bb..81eda7a5084 100644
--- a/docs/dyn/androidmanagement_v1.signupUrls.html
+++ b/docs/dyn/androidmanagement_v1.signupUrls.html
@@ -78,7 +78,7 @@ Instance Methods
close()
Close httplib2 connections.
- create(callbackUrl=None, projectId=None, x__xgafv=None)
+ create(adminEmail=None, callbackUrl=None, projectId=None, x__xgafv=None)
Creates an enterprise signup URL.
Method Details
@@ -87,10 +87,11 @@ Method Details
- create(callbackUrl=None, projectId=None, x__xgafv=None)
+ create(adminEmail=None, callbackUrl=None, projectId=None, x__xgafv=None)
Creates an enterprise signup URL.
Args:
+ adminEmail: string, Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user.
callbackUrl: string, The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.
projectId: string, The ID of the Google Cloud Platform project which will own the enterprise.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html
index a4ceafb8b69..a7d6da38d3f 100644
--- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html
+++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html
@@ -141,6 +141,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -189,6 +198,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -303,6 +317,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -351,6 +374,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -412,6 +440,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -460,6 +497,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html
index 0eaf3a6d603..49debb7dc4e 100644
--- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html
+++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html
@@ -145,6 +145,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -193,6 +202,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -238,6 +252,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -286,6 +309,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -333,6 +361,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -381,6 +418,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -422,6 +464,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -470,6 +521,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -514,6 +570,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -562,6 +627,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -599,6 +669,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -647,6 +726,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -704,6 +788,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -752,6 +845,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -800,6 +898,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -848,6 +955,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -902,6 +1014,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -950,6 +1071,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
@@ -993,6 +1119,15 @@ Method Details
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
+ "installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
+ "accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).
+ "billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
+ "committedPaymentsCount": 42, # Required. The number of payments the user is committed to.
+ "gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
+ "prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
+ "renewalType": "A String", # Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.
+ "resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
+ },
"offerTags": [ # List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
@@ -1041,6 +1176,11 @@ Method Details
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html
index 45db3cedc47..b45f312c772 100644
--- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html
+++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html
@@ -132,6 +132,13 @@ Method Details
{ # Item-level info for a subscription purchase.
"autoRenewingPlan": { # Information related to an auto renewing plan. # The item is auto renewing.
"autoRenewEnabled": True or False, # If the subscription is currently set to auto-renew, e.g. the user has not canceled the subscription
+ "installmentDetails": { # Information to a installment plan. # The installment plan commitment and state related info for the auto renewing plan.
+ "initialCommittedPaymentsCount": 42, # Total number of payments the user is initially committed for.
+ "pendingCancellation": { # This is an indicator of whether there is a pending cancellation on the virtual installment plan. The cancellation will happen only after the user finished all committed payments. # If present, this installment plan is pending to be canceled. The cancellation will happen only after the user finished all committed payments.
+ },
+ "remainingCommittedPaymentsCount": 42, # Total number of committed payments remaining to be paid for in this renewal cycle.
+ "subsequentCommittedPaymentsCount": 42, # Total number of payments the user will be committed for after each commitment period. Empty means the installment plan will fall back to a normal auto-renew subscription after initial commitment.
+ },
"priceChangeDetails": { # Price change related information of a subscription item. # The information of the last price change for the item since subscription signup.
"expectedNewPriceChargeTime": "A String", # The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause. This field is only populated if the price change has not taken effect.
"newPrice": { # Represents an amount of money with its currency type. # New recurring price for the subscription item.
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html
index 15de5f33e68..1dc73c65579 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html
@@ -127,7 +127,7 @@ Method Details
Args:
parent: string, Required. The name of the parent resource whose docker images will be listed. (required)
orderBy: string, The field to order the results by.
- pageSize: integer, The maximum number of artifacts to return.
+ pageSize: integer, The maximum number of artifacts to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html
index 5761d29efe5..8c8ee103c57 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html
@@ -171,7 +171,7 @@ Method Details
parent: string, Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 (required)
filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an ID starting with "a/b/". * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Files owned by the version `1.0` in package `pkg1`.
orderBy: string, The field to order the results by.
- pageSize: integer, The maximum number of files to return.
+ pageSize: integer, The maximum number of files to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html
index 6d13e4deff7..0ff14748d2c 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
-Directly uploads a Generic artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an ALREADY_EXISTS error.
+Directly uploads a Generic artifact. The returned operation will complete once the resources are uploaded. Package, version, and file resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an `ALREADY_EXISTS` error.
Method Details
close()
@@ -88,7 +88,7 @@ Method Details
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
- Directly uploads a Generic artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an ALREADY_EXISTS error.
+ Directly uploads a Generic artifact. The returned operation will complete once the resources are uploaded. Package, version, and file resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an `ALREADY_EXISTS` error.
Args:
parent: string, The resource name of the repository where the generic artifact will be uploaded. (required)
@@ -96,10 +96,9 @@ Method Details
The object takes the form of:
{ # The request to upload a generic artifact. The created GenericArtifact will have the resource name {parent}/genericArtifacts/package_id:version_id. The created file will have the resource name {parent}/files/package_id:version_id:filename.
- "filename": "A String", # The name of the file of the generic artifact to be uploaded. E.g. "example-file.zip" The filename should only include letters, numbers, and url safe characters, i.e. [a-zA-Z0-9-_.~@].
- "name": "A String", # Deprecated. Use package_id, version_id and filename instead. The resource name of the generic artifact. E.g. "projects/math/locations/us/repositories/operations/genericArtifacts/addition/1.0.0/add.py"
- "packageId": "A String", # The ID of the package of the generic artifact. If the package does not exist, a new package will be created. E.g. "pkg-1" The package_id must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.
- "versionId": "A String", # The ID of the version of the generic artifact. If the version does not exist, a new version will be created. E.g."1.0.0" The version_id must start and end with a letter or number, can only contain lowercase letters, numbers, hyphens and periods, i.e. [a-z0-9-.] and cannot exceed a total of 128 characters. While "latest" is a well-known name for the latest version of a package, it is not yet supported and is reserved for future use. Creating a version called "latest" is not allowed.
+ "filename": "A String", # The name of the file of the generic artifact to be uploaded. E.g. `example-file.zip` The filename is limited to letters, numbers, and url safe characters, i.e. [a-zA-Z0-9-_.~@].
+ "packageId": "A String", # The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.
+ "versionId": "A String", # The ID of the version of the generic artifact. If the version does not exist, a new version will be created. The version_id must start and end with a letter or number, can only contain lowercase letters, numbers, hyphens and periods, i.e. [a-z0-9-.] and cannot exceed a total of 128 characters. Creating a version called `latest` is not allowed.
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
index fac86d9b9af..4ea9294e38d 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
@@ -280,7 +280,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. If set, the repository satisfies physical zone separation.
"sizeBytes": "A String", # Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs.
"updateTime": "A String", # Output only. The time when the repository was last updated.
- "virtualRepositoryConfig": { # LINT.IfChange Virtual repository configuration. # Configuration specific for a Virtual Repository.
+ "virtualRepositoryConfig": { # Virtual repository configuration. # Configuration specific for a Virtual Repository.
"upstreamPolicies": [ # Policies that configure the upstream artifacts distributed by the Virtual Repository. Upstream policies cannot be set on a standard repository.
{ # Artifact policy configuration for the repository contents.
"id": "A String", # The user-provided ID of the upstream policy.
@@ -471,7 +471,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. If set, the repository satisfies physical zone separation.
"sizeBytes": "A String", # Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs.
"updateTime": "A String", # Output only. The time when the repository was last updated.
- "virtualRepositoryConfig": { # LINT.IfChange Virtual repository configuration. # Configuration specific for a Virtual Repository.
+ "virtualRepositoryConfig": { # Virtual repository configuration. # Configuration specific for a Virtual Repository.
"upstreamPolicies": [ # Policies that configure the upstream artifacts distributed by the Virtual Repository. Upstream policies cannot be set on a standard repository.
{ # Artifact policy configuration for the repository contents.
"id": "A String", # The user-provided ID of the upstream policy.
@@ -638,7 +638,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. If set, the repository satisfies physical zone separation.
"sizeBytes": "A String", # Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs.
"updateTime": "A String", # Output only. The time when the repository was last updated.
- "virtualRepositoryConfig": { # LINT.IfChange Virtual repository configuration. # Configuration specific for a Virtual Repository.
+ "virtualRepositoryConfig": { # Virtual repository configuration. # Configuration specific for a Virtual Repository.
"upstreamPolicies": [ # Policies that configure the upstream artifacts distributed by the Virtual Repository. Upstream policies cannot be set on a standard repository.
{ # Artifact policy configuration for the repository contents.
"id": "A String", # The user-provided ID of the upstream policy.
@@ -776,7 +776,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. If set, the repository satisfies physical zone separation.
"sizeBytes": "A String", # Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs.
"updateTime": "A String", # Output only. The time when the repository was last updated.
- "virtualRepositoryConfig": { # LINT.IfChange Virtual repository configuration. # Configuration specific for a Virtual Repository.
+ "virtualRepositoryConfig": { # Virtual repository configuration. # Configuration specific for a Virtual Repository.
"upstreamPolicies": [ # Policies that configure the upstream artifacts distributed by the Virtual Repository. Upstream policies cannot be set on a standard repository.
{ # Artifact policy configuration for the repository contents.
"id": "A String", # The user-provided ID of the upstream policy.
@@ -897,7 +897,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. If set, the repository satisfies physical zone separation.
"sizeBytes": "A String", # Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs.
"updateTime": "A String", # Output only. The time when the repository was last updated.
- "virtualRepositoryConfig": { # LINT.IfChange Virtual repository configuration. # Configuration specific for a Virtual Repository.
+ "virtualRepositoryConfig": { # Virtual repository configuration. # Configuration specific for a Virtual Repository.
"upstreamPolicies": [ # Policies that configure the upstream artifacts distributed by the Virtual Repository. Upstream policies cannot be set on a standard repository.
{ # Artifact policy configuration for the repository contents.
"id": "A String", # The user-provided ID of the upstream policy.
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.mavenArtifacts.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.mavenArtifacts.html
index feb673b4831..87ba4928884 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.mavenArtifacts.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.mavenArtifacts.html
@@ -123,7 +123,7 @@ Method Details
Args:
parent: string, Required. The name of the parent resource whose maven artifacts will be listed. (required)
- pageSize: integer, The maximum number of artifacts to return.
+ pageSize: integer, The maximum number of artifacts to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.npmPackages.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.npmPackages.html
index 27e59d16024..4e7ba5979fc 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.npmPackages.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.npmPackages.html
@@ -124,7 +124,7 @@ Method Details
Args:
parent: string, Required. The name of the parent resource whose npm packages will be listed. (required)
- pageSize: integer, The maximum number of artifacts to return.
+ pageSize: integer, The maximum number of artifacts to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html
index d91944f02d2..1521c991c93 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html
@@ -175,7 +175,7 @@ Method Details
Args:
parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required)
filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`.
- pageSize: integer, The maximum number of tags to return. Maximum page size is 10,000.
+ pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.pythonPackages.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.pythonPackages.html
index 167d2b3e97e..b248ecbc6e5 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.pythonPackages.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.pythonPackages.html
@@ -122,7 +122,7 @@ Method Details
Args:
parent: string, Required. The name of the parent resource whose python packages will be listed. (required)
- pageSize: integer, The maximum number of artifacts to return.
+ pageSize: integer, The maximum number of artifacts to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html
index 00bb20090ee..e9198e23df1 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html
+++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html
@@ -128,7 +128,7 @@ Method Details
Args:
parent: string, Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 (required)
filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an ID starting with "a/b/". * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Files owned by the version `1.0` in package `pkg1`.
- pageSize: integer, The maximum number of files to return.
+ pageSize: integer, The maximum number of files to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html
index 6b4c81ecf74..1196c545954 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html
+++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html
@@ -175,7 +175,7 @@ Method Details
Args:
parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required)
filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`.
- pageSize: integer, The maximum number of tags to return. Maximum page size is 10,000.
+ pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html
index 01fe8675f07..b08f2aade8b 100644
--- a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html
+++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html
@@ -169,7 +169,7 @@ Method Details
Args:
parent: string, Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 (required)
filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an ID starting with "a/b/". * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Files owned by the version `1.0` in package `pkg1`.
- pageSize: integer, The maximum number of files to return.
+ pageSize: integer, The maximum number of files to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html
index a409dd206cd..eb11fde56e6 100644
--- a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html
+++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html
@@ -175,7 +175,7 @@ Method Details
Args:
parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required)
filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`.
- pageSize: integer, The maximum number of tags to return. Maximum page size is 10,000.
+ pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/backupdr_v1.projects.locations.html b/docs/dyn/backupdr_v1.projects.locations.html
index 2df602e6dda..89d71804b82 100644
--- a/docs/dyn/backupdr_v1.projects.locations.html
+++ b/docs/dyn/backupdr_v1.projects.locations.html
@@ -74,11 +74,6 @@
Backup and DR Service API . projects . locations
Instance Methods
-
- backupVaults()
-
-Returns the backupVaults Resource.
-
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
index 6d998b21d4b..55e16e6cf92 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
@@ -154,9 +154,9 @@ Method Details
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}
- authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
+ authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
serviceAccountName: string, Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
- versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
+ versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -377,10 +377,10 @@ Method Details
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}
- authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
+ authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
serviceAccountName: string, Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
updateMask: string, Required. Required list of fields to be updated in this request.
- versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
+ versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
index 093a03b424b..e45dc32bf40 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
@@ -154,9 +154,9 @@ Method Details
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}
- authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
+ authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
serviceAccountName: string, Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
- versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
+ versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -377,10 +377,10 @@ Method Details
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}
- authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
+ authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
serviceAccountName: string, Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
updateMask: string, Required. Required list of fields to be updated in this request.
- versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
+ versionInfo: string, Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html
index a2acc318455..3f489db311e 100644
--- a/docs/dyn/chat_v1.spaces.html
+++ b/docs/dyn/chat_v1.spaces.html
@@ -118,7 +118,7 @@ Instance Methods
Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
setup(body=None, x__xgafv=None)
-Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
Method Details
close()
@@ -280,7 +280,7 @@ Method Details
Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
Args:
- name: string, Required. Resource name of the space, in the form "spaces/*". Format: `spaces/{space}` (required)
+ name: string, Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -423,14 +423,14 @@ Method Details
setup(body=None, x__xgafv=None)
- Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+ Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
Args:
body: object, The request body.
The object takes the form of:
{ # Request to create a space and add specified users to it.
- "memberships": [ # Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 20 memberships (in addition to the caller). The `Membership.member` field must contain a `user` with `name` populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the `user.name` can be `users/example@gmail.com`." To invite Gmail users or users from external Google Workspace domains, user's email must be used for `{user}`. Optional when setting `Space.spaceType` to `SPACE`. Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships. Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).
+ "memberships": [ # Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 20 memberships (in addition to the caller). For human membership, the `Membership.member` field must contain a `user` with `name` populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the `user.name` can be `users/example@gmail.com`. To invite Gmail users or users from external Google Workspace domains, user's email must be used for `{user}`. Optional when setting `Space.spaceType` to `SPACE`. Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships. Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).
{ # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.
"createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.
"deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.
diff --git a/docs/dyn/chat_v1.spaces.members.html b/docs/dyn/chat_v1.spaces.members.html
index 9e9ce59fb5a..8341a6b303d 100644
--- a/docs/dyn/chat_v1.spaces.members.html
+++ b/docs/dyn/chat_v1.spaces.members.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
-Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`.
+Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` for the human or app member. - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`.
Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -103,7 +103,7 @@ Method Details
create(parent, body=None, x__xgafv=None)
- Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`.
+ Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` for the human or app member. - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`.
Args:
parent: string, Required. The resource name of the space for which to create the membership. Format: spaces/{space} (required)
diff --git a/docs/dyn/chat_v1.spaces.messages.attachments.html b/docs/dyn/chat_v1.spaces.messages.attachments.html
index 8c82ef08517..62510c0df74 100644
--- a/docs/dyn/chat_v1.spaces.messages.attachments.html
+++ b/docs/dyn/chat_v1.spaces.messages.attachments.html
@@ -91,7 +91,7 @@ Method Details
Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
Args:
- name: string, Required. Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`. (required)
+ name: string, Required. Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -111,7 +111,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
}
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index fe402023c3a..72a105e713a 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -1180,7 +1180,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -2949,7 +2949,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -4736,7 +4736,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -6511,7 +6511,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -8291,7 +8291,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -10054,7 +10054,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -11817,7 +11817,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -13580,7 +13580,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html
index 680b6cf58d9..5495adf58db 100644
--- a/docs/dyn/chat_v1.spaces.spaceEvents.html
+++ b/docs/dyn/chat_v1.spaces.spaceEvents.html
@@ -1295,7 +1295,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -3053,7 +3053,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -4811,7 +4811,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -6567,7 +6567,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -8321,7 +8321,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -10075,7 +10075,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -12108,7 +12108,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -13866,7 +13866,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -15624,7 +15624,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -17380,7 +17380,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -19134,7 +19134,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
@@ -20888,7 +20888,7 @@ Method Details
"driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
"driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
},
- "name": "A String", # Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.
+ "name": "A String", # Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
"source": "A String", # Output only. The source of the attachment.
"thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
},
diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html
index b4ee3cab968..bcd8a860beb 100644
--- a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html
+++ b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html
@@ -111,6 +111,23 @@ Method Details
"nextPageToken": "A String", # Token to specify next page in the list.
"telemetryEvents": [ # Telemetry events returned in the response.
{ # Telemetry data reported by a managed device.
+ "appInstallEvent": { # App installation data. # Output only. Payload for app install event. Present only when `event_type` is `APP_INSTALLED`.
+ "appId": "A String", # App id. For PWAs this is the start URL, and for extensions this is the extension id.
+ "appInstallReason": "A String", # App installation reason.
+ "appInstallSource": "A String", # App installation source.
+ "appInstallTime": "A String", # App installation time depending on the app lifecycle.
+ "appType": "A String", # Type of app.
+ },
+ "appLaunchEvent": { # App launch data. # Output only. Payload for app launch event.Present only when `event_type` is `APP_LAUNCHED`.
+ "appId": "A String", # App id. For PWAs this is the start URL, and for extensions this is the extension id.
+ "appLaunchSource": "A String", # App launch source.
+ "appType": "A String", # Type of app.
+ },
+ "appUninstallEvent": { # App uninstall data. # Output only. Payload for app uninstall event. Present only when `event_type` is `APP_UNINSTALLED`.
+ "appId": "A String", # App id. For PWAs this is the start URL, and for extensions this is the extension id.
+ "appType": "A String", # Type of app.
+ "appUninstallSource": "A String", # App uninstall source.
+ },
"audioSevereUnderrunEvent": { # `TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds. * Granular permission needed: TELEMETRY_API_AUDIO_REPORT # Output only. Payload for audio severe underrun event. Present only when the `event_type` field is `AUDIO_SEVERE_UNDERRUN`.
},
"device": { # Information about a device associated with telemetry data. * Granular Permission needed: TELEMETRY_API_DEVICE # Output only. Information about the device associated with the event.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
index 08b2efe8487..7f2547924de 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html
@@ -932,12 +932,12 @@ Method Details
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
- "advanceAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by an advance rollout rule.
+ "advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout.
- "promoteAutomationRun": "A String", # Output only. The ID of the AutomationRun initiated by a promote release rule.
- "repairAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by a repair rollout rule.
+ "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
+ "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
@@ -1162,12 +1162,12 @@ Method Details
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
- "advanceAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by an advance rollout rule.
+ "advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout.
- "promoteAutomationRun": "A String", # Output only. The ID of the AutomationRun initiated by a promote release rule.
- "repairAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by a repair rollout rule.
+ "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
+ "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
index 5adef403d21..b0e88bf6698 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
@@ -417,6 +417,7 @@ Method Details
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
+ "verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
@@ -772,6 +773,7 @@ Method Details
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
+ "verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
@@ -1103,6 +1105,7 @@ Method Details
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
+ "verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
index a158cc5b92e..e1bf12595c1 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
@@ -219,12 +219,12 @@ Method Details
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
- "advanceAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by an advance rollout rule.
+ "advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout.
- "promoteAutomationRun": "A String", # Output only. The ID of the AutomationRun initiated by a promote release rule.
- "repairAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by a repair rollout rule.
+ "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
+ "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
@@ -479,12 +479,12 @@ Method Details
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
- "advanceAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by an advance rollout rule.
+ "advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout.
- "promoteAutomationRun": "A String", # Output only. The ID of the AutomationRun initiated by a promote release rule.
- "repairAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by a repair rollout rule.
+ "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
+ "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
@@ -740,12 +740,12 @@ Method Details
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
- "advanceAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by an advance rollout rule.
+ "advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout.
- "promoteAutomationRun": "A String", # Output only. The ID of the AutomationRun initiated by a promote release rule.
- "repairAutomationRuns": [ # Output only. The IDs of the AutomationRuns initiated by a repair rollout rule.
+ "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
+ "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.targets.html b/docs/dyn/clouddeploy_v1.projects.locations.targets.html
index c4a20b3a46c..a18ddc3272a 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.targets.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.targets.html
@@ -152,6 +152,7 @@ Method Details
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
+ "verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
@@ -295,6 +296,7 @@ Method Details
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
+ "verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
@@ -423,6 +425,7 @@ Method Details
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
+ "verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
@@ -510,6 +513,7 @@ Method Details
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
+ "verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html b/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html
index 4573184c05b..cbfc5b24832 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html
@@ -103,7 +103,7 @@ Method Details
{ # Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey.
"kmsKey": "A String", # Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig, the nearest of these configurations is used.
- "name": "A String", # Output only. Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
+ "name": "A String", # Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
"resourceTypeSelector": "A String", # Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g. `{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource types.
}
@@ -153,7 +153,7 @@ Method Details
{ # Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey.
"kmsKey": "A String", # Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig, the nearest of these configurations is used.
- "name": "A String", # Output only. Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
+ "name": "A String", # Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
"resourceTypeSelector": "A String", # Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g. `{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource types.
}
@@ -177,7 +177,7 @@ Method Details
"keyHandles": [ # Resulting KeyHandles.
{ # Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey.
"kmsKey": "A String", # Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig, the nearest of these configurations is used.
- "name": "A String", # Output only. Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
+ "name": "A String", # Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
"resourceTypeSelector": "A String", # Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g. `{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource types.
},
],
diff --git a/docs/dyn/compute_alpha.backendBuckets.html b/docs/dyn/compute_alpha.backendBuckets.html
index 8866a36d43d..43985904fc8 100644
--- a/docs/dyn/compute_alpha.backendBuckets.html
+++ b/docs/dyn/compute_alpha.backendBuckets.html
@@ -642,9 +642,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1342,9 +1339,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1437,9 +1431,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html
index fdab5ba6671..5da6fa53131 100644
--- a/docs/dyn/compute_alpha.backendServices.html
+++ b/docs/dyn/compute_alpha.backendServices.html
@@ -726,6 +726,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -1487,6 +1495,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -1619,9 +1635,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2092,6 +2105,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -2677,6 +2698,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -3160,6 +3189,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -3659,6 +3696,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -4004,9 +4049,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -4099,9 +4141,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -4736,6 +4775,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
index a173071489c..87333d13eff 100644
--- a/docs/dyn/compute_alpha.disks.html
+++ b/docs/dyn/compute_alpha.disks.html
@@ -1153,9 +1153,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1966,9 +1963,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2061,9 +2055,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.firewallPolicies.html b/docs/dyn/compute_alpha.firewallPolicies.html
index 6bfd5940977..e315e695c55 100644
--- a/docs/dyn/compute_alpha.firewallPolicies.html
+++ b/docs/dyn/compute_alpha.firewallPolicies.html
@@ -1219,9 +1219,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -3261,9 +3258,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -3356,9 +3350,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html
index 506b62ba034..4ca4214255f 100644
--- a/docs/dyn/compute_alpha.images.html
+++ b/docs/dyn/compute_alpha.images.html
@@ -735,9 +735,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1527,9 +1524,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1622,9 +1616,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html
index 543f225f96c..b14ae6d1d50 100644
--- a/docs/dyn/compute_alpha.instanceTemplates.html
+++ b/docs/dyn/compute_alpha.instanceTemplates.html
@@ -1096,9 +1096,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2092,9 +2089,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2187,9 +2181,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html
index 4ab2e9af0e6..8b454078dfa 100644
--- a/docs/dyn/compute_alpha.instances.html
+++ b/docs/dyn/compute_alpha.instances.html
@@ -3354,9 +3354,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -5666,9 +5663,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -5761,9 +5755,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.instantSnapshots.html b/docs/dyn/compute_alpha.instantSnapshots.html
index 88757cd26c8..41ce4b0f983 100644
--- a/docs/dyn/compute_alpha.instantSnapshots.html
+++ b/docs/dyn/compute_alpha.instantSnapshots.html
@@ -456,9 +456,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -806,9 +803,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -901,9 +895,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html
index 73ba9a261b0..aef05c92125 100644
--- a/docs/dyn/compute_alpha.interconnectAttachments.html
+++ b/docs/dyn/compute_alpha.interconnectAttachments.html
@@ -539,9 +539,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1166,9 +1163,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1261,9 +1255,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html
index 5d588f1a47e..ab9b73ea28e 100644
--- a/docs/dyn/compute_alpha.interconnects.html
+++ b/docs/dyn/compute_alpha.interconnects.html
@@ -474,9 +474,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1174,9 +1171,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1269,9 +1263,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.licenseCodes.html b/docs/dyn/compute_alpha.licenseCodes.html
index eb846bbd2ce..57bf58fb654 100644
--- a/docs/dyn/compute_alpha.licenseCodes.html
+++ b/docs/dyn/compute_alpha.licenseCodes.html
@@ -199,9 +199,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -313,9 +310,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -408,9 +402,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.licenses.html b/docs/dyn/compute_alpha.licenses.html
index 06e330d79c9..35ab6a302d4 100644
--- a/docs/dyn/compute_alpha.licenses.html
+++ b/docs/dyn/compute_alpha.licenses.html
@@ -336,9 +336,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -662,9 +659,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -757,9 +751,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html
index f274a1825b4..500a272359d 100644
--- a/docs/dyn/compute_alpha.machineImages.html
+++ b/docs/dyn/compute_alpha.machineImages.html
@@ -878,9 +878,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2290,9 +2287,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2385,9 +2379,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.networkAttachments.html b/docs/dyn/compute_alpha.networkAttachments.html
index 2b8bc177cdf..3655405cfe3 100644
--- a/docs/dyn/compute_alpha.networkAttachments.html
+++ b/docs/dyn/compute_alpha.networkAttachments.html
@@ -471,9 +471,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1004,9 +1001,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1099,9 +1093,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html
index 32d10d6cf36..711c1c0ba33 100644
--- a/docs/dyn/compute_alpha.networkFirewallPolicies.html
+++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html
@@ -1229,9 +1229,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -3263,9 +3260,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -3358,9 +3352,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.nodeGroups.html b/docs/dyn/compute_alpha.nodeGroups.html
index 3818d35513c..3623ff92717 100644
--- a/docs/dyn/compute_alpha.nodeGroups.html
+++ b/docs/dyn/compute_alpha.nodeGroups.html
@@ -785,9 +785,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1607,9 +1604,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1702,9 +1696,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.nodeTemplates.html b/docs/dyn/compute_alpha.nodeTemplates.html
index 0b065ae33a5..8e9edabe7e3 100644
--- a/docs/dyn/compute_alpha.nodeTemplates.html
+++ b/docs/dyn/compute_alpha.nodeTemplates.html
@@ -477,9 +477,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -851,9 +848,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -946,9 +940,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html
index 7397cfe5a26..98226353b9b 100644
--- a/docs/dyn/compute_alpha.regionBackendServices.html
+++ b/docs/dyn/compute_alpha.regionBackendServices.html
@@ -699,6 +699,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -833,9 +841,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1307,6 +1312,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -1893,6 +1906,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -2377,6 +2398,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -2877,6 +2906,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
@@ -3091,9 +3128,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -3186,9 +3220,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -3826,6 +3857,14 @@ Method Details
],
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
+ "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.
+ "name": "A String", # Name of the cookie.
+ "path": "A String", # Path to set for the cookie.
+ "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
"policy": "A String",
"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled.
diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html
index c77352a8363..491f393d51c 100644
--- a/docs/dyn/compute_alpha.regionDisks.html
+++ b/docs/dyn/compute_alpha.regionDisks.html
@@ -952,9 +952,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1765,9 +1762,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1860,9 +1854,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.regionInstantSnapshots.html b/docs/dyn/compute_alpha.regionInstantSnapshots.html
index bba3aa37edd..db1a2f3b527 100644
--- a/docs/dyn/compute_alpha.regionInstantSnapshots.html
+++ b/docs/dyn/compute_alpha.regionInstantSnapshots.html
@@ -352,9 +352,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -702,9 +699,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -797,9 +791,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html
index ec03791c8b2..6a8251221aa 100644
--- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html
+++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html
@@ -1180,9 +1180,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2807,9 +2804,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2902,9 +2896,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html
index a9dbac42397..6f99a6ece67 100644
--- a/docs/dyn/compute_alpha.regionSnapshots.html
+++ b/docs/dyn/compute_alpha.regionSnapshots.html
@@ -404,9 +404,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -858,9 +855,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -953,9 +947,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html
index fdc66d458e3..a54ee9a2fc4 100644
--- a/docs/dyn/compute_alpha.reservations.html
+++ b/docs/dyn/compute_alpha.reservations.html
@@ -583,9 +583,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1190,9 +1187,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1285,9 +1279,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html
index 35b9ecb0c4d..c599628f975 100644
--- a/docs/dyn/compute_alpha.resourcePolicies.html
+++ b/docs/dyn/compute_alpha.resourcePolicies.html
@@ -583,9 +583,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1281,9 +1278,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1376,9 +1370,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.serviceAttachments.html b/docs/dyn/compute_alpha.serviceAttachments.html
index d4d5ae4aab2..5ab2bc06680 100644
--- a/docs/dyn/compute_alpha.serviceAttachments.html
+++ b/docs/dyn/compute_alpha.serviceAttachments.html
@@ -502,9 +502,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1077,9 +1074,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1172,9 +1166,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html
index 84d65121919..32501603f7d 100644
--- a/docs/dyn/compute_alpha.snapshots.html
+++ b/docs/dyn/compute_alpha.snapshots.html
@@ -558,9 +558,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1009,9 +1006,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1104,9 +1098,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.storagePools.html b/docs/dyn/compute_alpha.storagePools.html
index 0d1352e0ad9..b6e7bfe9e89 100644
--- a/docs/dyn/compute_alpha.storagePools.html
+++ b/docs/dyn/compute_alpha.storagePools.html
@@ -538,9 +538,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1040,9 +1037,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1135,9 +1129,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html
index 14f793a3e20..7fc77e0793a 100644
--- a/docs/dyn/compute_alpha.subnetworks.html
+++ b/docs/dyn/compute_alpha.subnetworks.html
@@ -653,9 +653,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1327,9 +1324,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1422,9 +1416,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html
index fe4b9ed091f..4596cc6ecd5 100644
--- a/docs/dyn/compute_alpha.zoneQueuedResources.html
+++ b/docs/dyn/compute_alpha.zoneQueuedResources.html
@@ -497,9 +497,9 @@ Method Details
"selfLink": "A String", # [Output only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"state": "A String", # [Output only] High-level status of the request.
- "status": { # [Output only] Result of queuing and provisioning based on deferred capacity. # [Output only] Result of queuing and provisioning based on deferred capacity.
- "failedData": { # Additional status detail for the FAILED state. # Additional status detail for the FAILED state.
- "error": { # The error(s) that caused the QueuedResource to enter the FAILED state.
+ "status": { # [Output only] Result of queuing and provisioning based on deferred capacity.
+ "failedData": {
+ "error": {
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"code": "A String", # [Output Only] The error type identifier for this error.
@@ -542,10 +542,10 @@ Method Details
],
},
},
- "provisioningOperations": [ # [Output only] Fully qualified URL of the provisioning GCE operation to track the provisioning along with provisioning errors. The referenced operation may not exist after having been deleted or expired.
+ "provisioningOperations": [
"A String",
],
- "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # Constraints for the time when the resource(s) start provisioning. Always exposed as absolute times.
+ "queuingPolicy": { # Queuing parameters for the requested deferred capacity.
"validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
@@ -1243,9 +1243,9 @@ Method Details
"selfLink": "A String", # [Output only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"state": "A String", # [Output only] High-level status of the request.
- "status": { # [Output only] Result of queuing and provisioning based on deferred capacity. # [Output only] Result of queuing and provisioning based on deferred capacity.
- "failedData": { # Additional status detail for the FAILED state. # Additional status detail for the FAILED state.
- "error": { # The error(s) that caused the QueuedResource to enter the FAILED state.
+ "status": { # [Output only] Result of queuing and provisioning based on deferred capacity.
+ "failedData": {
+ "error": {
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"code": "A String", # [Output Only] The error type identifier for this error.
@@ -1288,10 +1288,10 @@ Method Details
],
},
},
- "provisioningOperations": [ # [Output only] Fully qualified URL of the provisioning GCE operation to track the provisioning along with provisioning errors. The referenced operation may not exist after having been deleted or expired.
+ "provisioningOperations": [
"A String",
],
- "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # Constraints for the time when the resource(s) start provisioning. Always exposed as absolute times.
+ "queuingPolicy": { # Queuing parameters for the requested deferred capacity.
"validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
@@ -1682,9 +1682,9 @@ Method Details
"selfLink": "A String", # [Output only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"state": "A String", # [Output only] High-level status of the request.
- "status": { # [Output only] Result of queuing and provisioning based on deferred capacity. # [Output only] Result of queuing and provisioning based on deferred capacity.
- "failedData": { # Additional status detail for the FAILED state. # Additional status detail for the FAILED state.
- "error": { # The error(s) that caused the QueuedResource to enter the FAILED state.
+ "status": { # [Output only] Result of queuing and provisioning based on deferred capacity.
+ "failedData": {
+ "error": {
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"code": "A String", # [Output Only] The error type identifier for this error.
@@ -1727,10 +1727,10 @@ Method Details
],
},
},
- "provisioningOperations": [ # [Output only] Fully qualified URL of the provisioning GCE operation to track the provisioning along with provisioning errors. The referenced operation may not exist after having been deleted or expired.
+ "provisioningOperations": [
"A String",
],
- "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # Constraints for the time when the resource(s) start provisioning. Always exposed as absolute times.
+ "queuingPolicy": { # Queuing parameters for the requested deferred capacity.
"validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
@@ -2251,9 +2251,9 @@ Method Details
"selfLink": "A String", # [Output only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"state": "A String", # [Output only] High-level status of the request.
- "status": { # [Output only] Result of queuing and provisioning based on deferred capacity. # [Output only] Result of queuing and provisioning based on deferred capacity.
- "failedData": { # Additional status detail for the FAILED state. # Additional status detail for the FAILED state.
- "error": { # The error(s) that caused the QueuedResource to enter the FAILED state.
+ "status": { # [Output only] Result of queuing and provisioning based on deferred capacity.
+ "failedData": {
+ "error": {
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"code": "A String", # [Output Only] The error type identifier for this error.
@@ -2296,10 +2296,10 @@ Method Details
],
},
},
- "provisioningOperations": [ # [Output only] Fully qualified URL of the provisioning GCE operation to track the provisioning along with provisioning errors. The referenced operation may not exist after having been deleted or expired.
+ "provisioningOperations": [
"A String",
],
- "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # Constraints for the time when the resource(s) start provisioning. Always exposed as absolute times.
+ "queuingPolicy": { # Queuing parameters for the requested deferred capacity.
"validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
diff --git a/docs/dyn/compute_beta.backendBuckets.html b/docs/dyn/compute_beta.backendBuckets.html
index 7b2e6d058d5..036e1bc8546 100644
--- a/docs/dyn/compute_beta.backendBuckets.html
+++ b/docs/dyn/compute_beta.backendBuckets.html
@@ -638,9 +638,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1332,9 +1329,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1427,9 +1421,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html
index f8b40a6ffb8..17f6f9b00c3 100644
--- a/docs/dyn/compute_beta.backendServices.html
+++ b/docs/dyn/compute_beta.backendServices.html
@@ -1138,9 +1138,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2564,9 +2561,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2659,9 +2653,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html
index b915dbe4061..24245e9c977 100644
--- a/docs/dyn/compute_beta.disks.html
+++ b/docs/dyn/compute_beta.disks.html
@@ -1137,9 +1137,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1941,9 +1938,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2036,9 +2030,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html
index 6b75e964327..5e607354b89 100644
--- a/docs/dyn/compute_beta.firewallPolicies.html
+++ b/docs/dyn/compute_beta.firewallPolicies.html
@@ -927,9 +927,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2324,9 +2321,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2419,9 +2413,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html
index f0e81fbf6c1..51246f5819a 100644
--- a/docs/dyn/compute_beta.images.html
+++ b/docs/dyn/compute_beta.images.html
@@ -731,9 +731,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1518,9 +1515,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1613,9 +1607,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html
index 26dbe507138..f13c66c3729 100644
--- a/docs/dyn/compute_beta.instanceTemplates.html
+++ b/docs/dyn/compute_beta.instanceTemplates.html
@@ -1003,9 +1003,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1906,9 +1903,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2001,9 +1995,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html
index c7bfb33a111..d3254bc9924 100644
--- a/docs/dyn/compute_beta.instances.html
+++ b/docs/dyn/compute_beta.instances.html
@@ -2773,9 +2773,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -4893,9 +4890,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -4988,9 +4982,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.instantSnapshots.html b/docs/dyn/compute_beta.instantSnapshots.html
index 8b4ddc1f5c4..01c4bdbf116 100644
--- a/docs/dyn/compute_beta.instantSnapshots.html
+++ b/docs/dyn/compute_beta.instantSnapshots.html
@@ -453,9 +453,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -800,9 +797,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -895,9 +889,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.licenses.html b/docs/dyn/compute_beta.licenses.html
index 54abc27acd0..8e8cbd0ed44 100644
--- a/docs/dyn/compute_beta.licenses.html
+++ b/docs/dyn/compute_beta.licenses.html
@@ -334,9 +334,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -657,9 +654,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -752,9 +746,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html
index 447b3b57a2b..2486ed05c06 100644
--- a/docs/dyn/compute_beta.machineImages.html
+++ b/docs/dyn/compute_beta.machineImages.html
@@ -804,9 +804,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2069,9 +2066,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2164,9 +2158,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.networkAttachments.html b/docs/dyn/compute_beta.networkAttachments.html
index 8cf8a2db79f..4dd5d5bc7ec 100644
--- a/docs/dyn/compute_beta.networkAttachments.html
+++ b/docs/dyn/compute_beta.networkAttachments.html
@@ -470,9 +470,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1001,9 +998,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1096,9 +1090,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html
index 5c60d3def35..44c593e57a0 100644
--- a/docs/dyn/compute_beta.networkFirewallPolicies.html
+++ b/docs/dyn/compute_beta.networkFirewallPolicies.html
@@ -930,9 +930,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2181,9 +2178,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2276,9 +2270,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.nodeGroups.html b/docs/dyn/compute_beta.nodeGroups.html
index 5fb34d6b94f..1186bb50f0d 100644
--- a/docs/dyn/compute_beta.nodeGroups.html
+++ b/docs/dyn/compute_beta.nodeGroups.html
@@ -768,9 +768,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1560,9 +1557,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1655,9 +1649,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.nodeTemplates.html b/docs/dyn/compute_beta.nodeTemplates.html
index 336cde5ddcb..7cd893aea98 100644
--- a/docs/dyn/compute_beta.nodeTemplates.html
+++ b/docs/dyn/compute_beta.nodeTemplates.html
@@ -474,9 +474,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -845,9 +842,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -940,9 +934,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html
index 4643db100d6..d6b9019e7f6 100644
--- a/docs/dyn/compute_beta.regionBackendServices.html
+++ b/docs/dyn/compute_beta.regionBackendServices.html
@@ -593,9 +593,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1893,9 +1890,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1988,9 +1982,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html
index 252aa9ed6d3..49b803d8914 100644
--- a/docs/dyn/compute_beta.regionDisks.html
+++ b/docs/dyn/compute_beta.regionDisks.html
@@ -938,9 +938,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1742,9 +1739,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1837,9 +1831,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.regionInstantSnapshots.html b/docs/dyn/compute_beta.regionInstantSnapshots.html
index 0144b5a5cb3..0be40c9b832 100644
--- a/docs/dyn/compute_beta.regionInstantSnapshots.html
+++ b/docs/dyn/compute_beta.regionInstantSnapshots.html
@@ -350,9 +350,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -697,9 +694,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -792,9 +786,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html
index e77ec4a2bcd..62497eb8b04 100644
--- a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html
+++ b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html
@@ -1093,9 +1093,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2352,9 +2349,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2447,9 +2441,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html
index d0d0a2c9bea..d2eb7384d19 100644
--- a/docs/dyn/compute_beta.reservations.html
+++ b/docs/dyn/compute_beta.reservations.html
@@ -570,9 +570,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1163,9 +1160,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1258,9 +1252,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.resourcePolicies.html b/docs/dyn/compute_beta.resourcePolicies.html
index a52dab78453..39631473dd0 100644
--- a/docs/dyn/compute_beta.resourcePolicies.html
+++ b/docs/dyn/compute_beta.resourcePolicies.html
@@ -552,9 +552,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1202,9 +1199,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1297,9 +1291,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.serviceAttachments.html b/docs/dyn/compute_beta.serviceAttachments.html
index 3eaa4660bc1..e4a238a82f6 100644
--- a/docs/dyn/compute_beta.serviceAttachments.html
+++ b/docs/dyn/compute_beta.serviceAttachments.html
@@ -501,9 +501,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1074,9 +1071,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1169,9 +1163,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html
index 5900e71df84..b6e5b277ba6 100644
--- a/docs/dyn/compute_beta.snapshots.html
+++ b/docs/dyn/compute_beta.snapshots.html
@@ -394,9 +394,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -832,9 +829,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -927,9 +921,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.storagePools.html b/docs/dyn/compute_beta.storagePools.html
index 7c72a85e896..5a20672a950 100644
--- a/docs/dyn/compute_beta.storagePools.html
+++ b/docs/dyn/compute_beta.storagePools.html
@@ -500,9 +500,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -967,9 +964,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1062,9 +1056,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html
index 2c1f682f89e..d729c92bdb0 100644
--- a/docs/dyn/compute_beta.subnetworks.html
+++ b/docs/dyn/compute_beta.subnetworks.html
@@ -633,9 +633,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1260,9 +1257,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1355,9 +1349,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.backendBuckets.html b/docs/dyn/compute_v1.backendBuckets.html
index c5b5dbf9a1f..ef9fff64076 100644
--- a/docs/dyn/compute_v1.backendBuckets.html
+++ b/docs/dyn/compute_v1.backendBuckets.html
@@ -638,9 +638,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1332,9 +1329,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1427,9 +1421,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html
index e24921dc4e8..c7c81e807ec 100644
--- a/docs/dyn/compute_v1.backendServices.html
+++ b/docs/dyn/compute_v1.backendServices.html
@@ -1122,9 +1122,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2520,9 +2517,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2615,9 +2609,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index 2470d61c1c7..8f1f323e615 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -1117,9 +1117,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1905,9 +1902,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2000,9 +1994,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.firewallPolicies.html b/docs/dyn/compute_v1.firewallPolicies.html
index eb68af4eb76..514bfd44bd0 100644
--- a/docs/dyn/compute_v1.firewallPolicies.html
+++ b/docs/dyn/compute_v1.firewallPolicies.html
@@ -927,9 +927,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2324,9 +2321,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2419,9 +2413,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html
index 5d2e38569ab..8e6ab34a95c 100644
--- a/docs/dyn/compute_v1.images.html
+++ b/docs/dyn/compute_v1.images.html
@@ -693,9 +693,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1431,9 +1428,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1526,9 +1520,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html
index 7ac687f33f4..22fb8545503 100644
--- a/docs/dyn/compute_v1.instanceTemplates.html
+++ b/docs/dyn/compute_v1.instanceTemplates.html
@@ -920,9 +920,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1740,9 +1737,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1835,9 +1829,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index 7b2bcdbc41e..82feb1280e9 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -2455,9 +2455,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -4262,9 +4259,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -4357,9 +4351,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.instantSnapshots.html b/docs/dyn/compute_v1.instantSnapshots.html
index c6a55d274d3..5d93258ce25 100644
--- a/docs/dyn/compute_v1.instantSnapshots.html
+++ b/docs/dyn/compute_v1.instantSnapshots.html
@@ -453,9 +453,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -800,9 +797,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -895,9 +889,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.licenses.html b/docs/dyn/compute_v1.licenses.html
index 2fe854e5ddf..754270286c8 100644
--- a/docs/dyn/compute_v1.licenses.html
+++ b/docs/dyn/compute_v1.licenses.html
@@ -334,9 +334,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -657,9 +654,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -752,9 +746,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html
index 631992ff28a..a30620c98ac 100644
--- a/docs/dyn/compute_v1.machineImages.html
+++ b/docs/dyn/compute_v1.machineImages.html
@@ -753,9 +753,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1916,9 +1913,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2011,9 +2005,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.networkAttachments.html b/docs/dyn/compute_v1.networkAttachments.html
index fa4158c3087..c4626750c7f 100644
--- a/docs/dyn/compute_v1.networkAttachments.html
+++ b/docs/dyn/compute_v1.networkAttachments.html
@@ -470,9 +470,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1001,9 +998,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1096,9 +1090,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.networkFirewallPolicies.html b/docs/dyn/compute_v1.networkFirewallPolicies.html
index 950a071df22..a1cad6650e0 100644
--- a/docs/dyn/compute_v1.networkFirewallPolicies.html
+++ b/docs/dyn/compute_v1.networkFirewallPolicies.html
@@ -930,9 +930,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2181,9 +2178,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2276,9 +2270,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.nodeGroups.html b/docs/dyn/compute_v1.nodeGroups.html
index 23fc7b61bf8..06fdab4c95d 100644
--- a/docs/dyn/compute_v1.nodeGroups.html
+++ b/docs/dyn/compute_v1.nodeGroups.html
@@ -762,9 +762,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1545,9 +1542,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1640,9 +1634,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.nodeTemplates.html b/docs/dyn/compute_v1.nodeTemplates.html
index 5d4c61e5fb9..a1ab3ae05b9 100644
--- a/docs/dyn/compute_v1.nodeTemplates.html
+++ b/docs/dyn/compute_v1.nodeTemplates.html
@@ -474,9 +474,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -845,9 +842,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -940,9 +934,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html
index e69293401d4..779efce6e59 100644
--- a/docs/dyn/compute_v1.regionBackendServices.html
+++ b/docs/dyn/compute_v1.regionBackendServices.html
@@ -584,9 +584,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1856,9 +1853,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1951,9 +1945,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html
index 19edba715c8..9e3ff13e9f9 100644
--- a/docs/dyn/compute_v1.regionDisks.html
+++ b/docs/dyn/compute_v1.regionDisks.html
@@ -926,9 +926,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1714,9 +1711,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1809,9 +1803,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.regionInstantSnapshots.html b/docs/dyn/compute_v1.regionInstantSnapshots.html
index e8d4aeb19c5..703204067d0 100644
--- a/docs/dyn/compute_v1.regionInstantSnapshots.html
+++ b/docs/dyn/compute_v1.regionInstantSnapshots.html
@@ -350,9 +350,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -697,9 +694,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -792,9 +786,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html
index c040aeb8787..59fcd8f6c9d 100644
--- a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html
+++ b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html
@@ -1092,9 +1092,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2351,9 +2348,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -2446,9 +2440,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html
index d6dfd601914..7ab21db79ee 100644
--- a/docs/dyn/compute_v1.reservations.html
+++ b/docs/dyn/compute_v1.reservations.html
@@ -550,9 +550,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1123,9 +1120,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1218,9 +1212,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.resourcePolicies.html b/docs/dyn/compute_v1.resourcePolicies.html
index 4a92bacf18e..465dcf74e7e 100644
--- a/docs/dyn/compute_v1.resourcePolicies.html
+++ b/docs/dyn/compute_v1.resourcePolicies.html
@@ -546,9 +546,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1187,9 +1184,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1282,9 +1276,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.serviceAttachments.html b/docs/dyn/compute_v1.serviceAttachments.html
index 81864caa484..1190721c2df 100644
--- a/docs/dyn/compute_v1.serviceAttachments.html
+++ b/docs/dyn/compute_v1.serviceAttachments.html
@@ -489,9 +489,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1044,9 +1041,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1139,9 +1133,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html
index 6f4b40d182f..b6c138e2e8b 100644
--- a/docs/dyn/compute_v1.snapshots.html
+++ b/docs/dyn/compute_v1.snapshots.html
@@ -390,9 +390,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -820,9 +817,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -915,9 +909,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.storagePools.html b/docs/dyn/compute_v1.storagePools.html
index 6a036f75351..2b04c864ec6 100644
--- a/docs/dyn/compute_v1.storagePools.html
+++ b/docs/dyn/compute_v1.storagePools.html
@@ -500,9 +500,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -967,9 +964,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1062,9 +1056,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html
index bd23de60aaf..03762234d02 100644
--- a/docs/dyn/compute_v1.subnetworks.html
+++ b/docs/dyn/compute_v1.subnetworks.html
@@ -631,9 +631,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1254,9 +1251,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
@@ -1349,9 +1343,6 @@ Method Details
"logConfigs": [ # This is deprecated and has no effect. Do not use.
{ # This is deprecated and has no effect. Do not use.
"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
- "permissionType": "A String", # This is deprecated and has no effect. Do not use.
- },
"logName": "A String", # This is deprecated and has no effect. Do not use.
},
"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html
index 67d36febf40..8902e70fb89 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html
@@ -503,6 +503,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
index baa6ba3b65a..fd0c62562bc 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
@@ -519,6 +519,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
@@ -1405,6 +1410,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
@@ -2315,6 +2325,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
@@ -3612,6 +3627,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
@@ -4515,6 +4535,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
@@ -5401,6 +5426,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html
index 551cc11e7c4..e668a1862da 100644
--- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html
+++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html
@@ -503,6 +503,11 @@ Method Details
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
+ "version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
+ "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
+ "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+ "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+ },
},
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
diff --git a/docs/dyn/content_v2_1.products.html b/docs/dyn/content_v2_1.products.html
index a19296c7b16..8a6d0ad90d6 100644
--- a/docs/dyn/content_v2_1.products.html
+++ b/docs/dyn/content_v2_1.products.html
@@ -144,6 +144,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -240,7 +241,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -253,6 +254,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
@@ -448,6 +464,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -544,7 +561,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -557,6 +574,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
@@ -758,6 +790,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -854,7 +887,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -867,6 +900,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
@@ -1043,6 +1091,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -1139,7 +1188,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -1152,6 +1201,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
@@ -1327,6 +1391,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -1423,7 +1488,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -1436,6 +1501,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
@@ -1623,6 +1703,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -1719,7 +1800,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -1732,6 +1813,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
@@ -1925,6 +2021,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -2021,7 +2118,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -2034,6 +2131,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
@@ -2209,6 +2321,7 @@ Method Details
"certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters.
"certificationCode": "A String", # The certification code, for eaxample "123456". Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters.
+ "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
@@ -2305,7 +2418,7 @@ Method Details
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
- "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item.
+ "loyaltyProgram": { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446 # Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.
"cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -2318,6 +2431,21 @@ Method Details
"programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
"tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
},
+ "loyaltyPrograms": [ # Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
+ { # Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
+ "cashbackForFutureUse": { # Optional. The cashback that can be used for future purchases.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase.
+ "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "programLabel": "A String", # Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
+ "tierLabel": "A String", # Required. The label of the tier within the loyalty program. Must match one of the labels within the program.
+ },
+ ],
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
diff --git a/docs/dyn/content_v2_1.reports.html b/docs/dyn/content_v2_1.reports.html
index f2e5ec8cb81..a03820c588d 100644
--- a/docs/dyn/content_v2_1.reports.html
+++ b/docs/dyn/content_v2_1.reports.html
@@ -154,29 +154,29 @@ Method Details
"yourDomainVisibilityTrend": 3.14, # Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions). Available only in `CompetitiveVisibilityBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.
},
"metrics": { # Performance metrics. Values are only set for metrics requested explicitly in the request's search query. # Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query.
- "aos": 3.14, # Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions and customer_country_code.**
- "aovMicros": 3.14, # Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**
+ "aos": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions and customer_country_code.**
+ "aovMicros": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**
"clicks": "A String", # Number of clicks.
- "conversionRate": 3.14, # Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the FREE_PRODUCT_LISTING program.
- "conversionValueMicros": "A String", # Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.
- "conversions": 3.14, # Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. The metric is currently available only for the FREE_PRODUCT_LISTING program.
+ "conversionRate": 3.14, # Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the `FREE_PRODUCT_LISTING` program.
+ "conversionValueMicros": "A String", # Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the `FREE_PRODUCT_LISTING` program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.
+ "conversions": 3.14, # Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. The metric is currently available only for the `FREE_PRODUCT_LISTING` program.
"ctr": 3.14, # Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).
- "daysToShip": 3.14, # Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**
+ "daysToShip": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**
"impressions": "A String", # Number of times merchant's products are shown.
- "itemDaysToShip": 3.14, # Average number of days between an item being ordered and the item being **This metric cannot be segmented by customer_country_code.**
- "itemFillRate": 3.14, # Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. **This metric cannot be segmented by customer_country_code.**
- "orderedItemSalesMicros": "A String", # Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
- "orderedItems": "A String", # Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by customer_country_code.**
- "orders": "A String", # Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions and customer_country_code.**
- "rejectedItems": "A String", # Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by customer_country_code.**
- "returnRate": 3.14, # Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
- "returnedItems": "A String", # Number of ordered items sent back for return, reported on the date when the merchant accepted the return. **This metric cannot be segmented by customer_country_code.**
- "returnsMicros": "A String", # Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
- "shippedItemSalesMicros": "A String", # Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
- "shippedItems": "A String", # Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.**
- "shippedOrders": "A String", # Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**
- "unshippedItems": 3.14, # Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. **This metric cannot be segmented by customer_country_code.**
- "unshippedOrders": 3.14, # Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.**
+ "itemDaysToShip": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an item being ordered and the item being **This metric cannot be segmented by customer_country_code.**
+ "itemFillRate": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. **This metric cannot be segmented by customer_country_code.**
+ "orderedItemSalesMicros": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
+ "orderedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by customer_country_code.**
+ "orders": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions and customer_country_code.**
+ "rejectedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by customer_country_code.**
+ "returnRate": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
+ "returnedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items sent back for return, reported on the date when the merchant accepted the return. **This metric cannot be segmented by customer_country_code.**
+ "returnsMicros": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
+ "shippedItemSalesMicros": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
+ "shippedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.**
+ "shippedOrders": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**
+ "unshippedItems": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. **This metric cannot be segmented by customer_country_code.**
+ "unshippedOrders": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.**
},
"priceCompetitiveness": { # Price competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`. https://support.google.com/merchants/answer/9626903 # Price competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`.
"benchmarkPriceCurrencyCode": "A String", # The price benchmark currency (ISO 4217 code).
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html
index 507f218d41f..93240617008 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html
@@ -88,7 +88,7 @@ Instance Methods
Gets a Document.
import_(parent, body=None, x__xgafv=None)
-Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
+Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Gets a list of Documents.
@@ -136,7 +136,7 @@ Method Details
},
}
- documentId: string, Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+ documentId: string, Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -221,7 +221,7 @@ Method Details
import_(parent, body=None, x__xgafv=None)
- Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
+ Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. (required)
@@ -281,14 +281,14 @@ Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.
},
"firestoreSource": { # Firestore source import data from. # Firestore input source.
- "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.
+ "collectionId": "A String", # Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.
"databaseId": "A String", # Required. The Firestore database to copy the data from with a length limit of 256 characters.
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
"projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
},
"gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
- "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
- "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+ "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+ "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
"A String",
],
},
@@ -362,7 +362,7 @@ Method Details
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. (required)
- pageSize: integer, Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+ pageSize: integer, Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
pageToken: string, A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
x__xgafv: string, V1 error format.
Allowed values
@@ -441,8 +441,8 @@ Method Details
},
}
- allowMissing: boolean, If set to true, and the Document is not found, a new Document will be created.
- updateMask: string, Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
+ allowMissing: boolean, If set to `true` and the Document is not found, a new Document is be created.
+ updateMask: string, Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html
index 33f261fc071..874f29cb022 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . collections . dataStores . branches . operations
Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -87,6 +90,30 @@ Instance Methods
list_next()
Retrieves the next page of results.
Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
index 16b206470a1..8d397e1f314 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
@@ -128,7 +128,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -234,7 +234,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -295,7 +295,7 @@ Method Details
"userPseudoId": "A String", # A unique identifier for tracking users.
},
"reply": { # Defines a reply message to user. # Answer to the current query.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -341,7 +341,7 @@ Method Details
},
"searchResults": [ # Search Results.
{ # Represents the search results.
- "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+ "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -381,7 +381,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -456,7 +456,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -556,7 +556,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -644,7 +644,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -738,7 +738,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -814,7 +814,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
index ac15b767e6f..6e9c0342494 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
@@ -104,6 +104,11 @@ Instance Methods
Returns the servingConfigs Resource.
+
+ sessions()
+
+Returns the sessions Resource.
+
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.schemas.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.schemas.html
index 184dba7f587..e1073d231a9 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.schemas.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.schemas.html
@@ -123,7 +123,7 @@ Method Details
},
}
- schemaId: string, Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+ schemaId: string, Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -217,7 +217,7 @@ Method Details
Args:
parent: string, Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. (required)
- pageSize: integer, The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageSize: integer, The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.
pageToken: string, A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
@@ -272,7 +272,7 @@ Method Details
},
}
- allowMissing: boolean, If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.
+ allowMissing: boolean, If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
index 5f016c9f872..b9d839c8997 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . collections . dataStores . servingConfigs
Instance Methods
+
+ answer(servingConfig, body=None, x__xgafv=None)
+Answer query method.
Close httplib2 connections.
@@ -87,6 +90,224 @@ Instance Methods
search_next()
Retrieves the next page of results.
Method Details
+
+ answer(servingConfig, body=None, x__xgafv=None)
+ Answer query method.
+
+Args:
+ servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+ "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+ "answerLanguageCode": "A String", # Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+ "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.
+ "ignoreNonAnswerSeekingQuery": True or False, # Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+ "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+ "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+ "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+ },
+ "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+ "preamble": "A String", # Customized preamble.
+ },
+ },
+ "asynchronousMode": True or False, # Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
+ "query": { # Defines a user inputed query. # Required. Current user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+ "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+ "types": [ # Enabled query classification types.
+ "A String",
+ ],
+ },
+ "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+ "disable": True or False, # Disable query rephraser.
+ },
+ },
+ "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+ "enable": True or False, # Enable related questions feature if true.
+ },
+ "safetySpec": { # Safety specification. # Model specification.
+ "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+ },
+ "searchSpec": { # Search specification. # Search specification.
+ "searchParams": { # Search parameters. # Search parameters.
+ "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+ "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+ { # Boost applies to documents which match a condition.
+ "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+ "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+ },
+ ],
+ },
+ "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+ "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+ },
+ "searchResultList": { # Search result list. # Search result list.
+ "searchResults": [ # Search results.
+ { # Search result.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "document": "A String", # Document resource name.
+ "documentContexts": [ # List of document contexts.
+ { # Document context.
+ "content": "A String", # Document content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "extractiveAnswers": [ # List of extractive answers.
+ { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+ "content": "A String", # Extractive answer content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "extractiveSegments": [ # List of extractive segments.
+ { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+ "content": "A String", # Extractive segment content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ },
+ },
+ "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.
+ "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ConversationalSearchService.AnswerQuery method.
+ "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+ "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+ "A String",
+ ],
+ "answerText": "A String", # The textual answer.
+ "citations": [ # Citations.
+ { # Citation info for a segment.
+ "endIndex": "A String", # End of the attributed segment, exclusive.
+ "sources": [ # Citation sources for the attributed segment.
+ { # Citation source.
+ "referenceId": "A String", # ID of the citation source.
+ },
+ ],
+ "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+ },
+ ],
+ "completeTime": "A String", # Output only. Answer completed timestamp.
+ "createTime": "A String", # Output only. Answer creation timestamp.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+ "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+ "queryClassificationInfo": [ # Query classification information.
+ { # Query classification information.
+ "positive": True or False, # Classification output.
+ "type": "A String", # Query classification type.
+ },
+ ],
+ },
+ "references": [ # References.
+ { # Reference.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "documentMetadata": { # Document metadata. # Document metadata.
+ "document": "A String", # Document resource name.
+ "pageIdentifier": "A String", # Page identifier.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "chunkContents": [ # List of cited chunk contents derived from document content.
+ { # Chunk content.
+ "content": "A String", # Chunk textual content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ "relatedQuestions": [ # Suggested related questions.
+ "A String",
+ ],
+ "state": "A String", # The state of the answer generation.
+ "steps": [ # Answer generation steps.
+ { # Step information.
+ "actions": [ # Actions.
+ { # Action.
+ "observation": { # Observation. # Observation.
+ "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+ {
+ "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+ { # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+ { # Snippet information.
+ "snippet": "A String", # Snippet content.
+ "snippetStatus": "A String", # Status of the snippet defined by the search team.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ ],
+ },
+ "searchAction": { # Search action. # Search action.
+ "query": "A String", # The query to search.
+ },
+ },
+ ],
+ "description": "A String", # The description of the step.
+ "state": "A String", # The state of the step.
+ "thought": "A String", # The thought of the step.
+ },
+ ],
+ },
+ "answerQueryToken": "A String", # A global unique ID used for logging.
+ "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+ },
+}
+
+
close()
Close httplib2 connections.
@@ -97,17 +318,17 @@ Method Details
Makes a recommendation, which requires a contextual user event.
Args:
- servingConfig: string, Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. (required)
+ servingConfig: string, Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for Recommend method.
- "filter": "A String", # Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
- "pageSize": 42, # Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
- "params": { # Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
+ "filter": "A String", # Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
+ "pageSize": 42, # Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.
+ "params": { # Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
"a_key": "",
},
- "userEvent": { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.
+ "userEvent": { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website. # Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -131,7 +352,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -163,7 +384,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -183,7 +404,7 @@ Method Details
"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
"a_key": "A String",
},
- "validateOnly": True or False, # Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
+ "validateOnly": True or False, # Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
}
x__xgafv: string, V1 error format.
@@ -221,7 +442,7 @@ Method Details
},
},
"id": "A String", # Resource ID of the recommended Document.
- "metadata": { # Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.
+ "metadata": { # Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.
"a_key": "",
},
},
@@ -240,7 +461,7 @@ Method Details
The object takes the form of:
{ # Request message for SearchService.Search method.
- "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+ "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
{ # Boost applies to documents which match a condition.
"boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
@@ -278,8 +499,8 @@ Method Details
"useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
},
},
- "dataStoreSpecs": [ # A list of data store specs to apply on a search call.
- { # A struct to define data stores to filter on in a search call.
+ "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+ { # A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
},
],
@@ -291,7 +512,7 @@ Method Details
],
"facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
"caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
- "contains": [ # Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+ "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
"A String",
],
"intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
@@ -311,7 +532,7 @@ Method Details
"A String",
],
},
- "limit": 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
+ "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -322,7 +543,7 @@ Method Details
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
"pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
"pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
- "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1
+ "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
"a_key": "",
},
"query": "A String", # Raw search query.
@@ -332,7 +553,7 @@ Method Details
},
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
- "mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.
+ "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
},
"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
@@ -358,7 +579,7 @@ Method Details
"facets": [ # Results of facets requested by user.
{ # A facet result.
"dynamicFacet": True or False, # Whether the facet is dynamically generated.
- "key": "A String", # The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.
+ "key": "A String", # The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key.
"values": [ # The facet values for this field.
{ # A facet value which contains value names and their count.
"count": "A String", # Number of items that have this facet value.
@@ -381,7 +602,7 @@ Method Details
"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
"results": [ # A list of matched documents. The order represents the ranking.
{ # Represents the search results.
- "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+ "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -403,7 +624,7 @@ Method Details
"id": "A String", # Document.id of the searched Document.
},
],
- "summary": { # Summary of the top N search result specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
+ "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html
new file mode 100644
index 00000000000..b3cf300ac84
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html
@@ -0,0 +1,199 @@
+
+
+
+Discovery Engine API . projects . locations . collections . dataStores . sessions . answers
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+Gets a Answer.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets a Answer.
+
+Args:
+ name: string, Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an answer.
+ "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+ "A String",
+ ],
+ "answerText": "A String", # The textual answer.
+ "citations": [ # Citations.
+ { # Citation info for a segment.
+ "endIndex": "A String", # End of the attributed segment, exclusive.
+ "sources": [ # Citation sources for the attributed segment.
+ { # Citation source.
+ "referenceId": "A String", # ID of the citation source.
+ },
+ ],
+ "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+ },
+ ],
+ "completeTime": "A String", # Output only. Answer completed timestamp.
+ "createTime": "A String", # Output only. Answer creation timestamp.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+ "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+ "queryClassificationInfo": [ # Query classification information.
+ { # Query classification information.
+ "positive": True or False, # Classification output.
+ "type": "A String", # Query classification type.
+ },
+ ],
+ },
+ "references": [ # References.
+ { # Reference.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "documentMetadata": { # Document metadata. # Document metadata.
+ "document": "A String", # Document resource name.
+ "pageIdentifier": "A String", # Page identifier.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "chunkContents": [ # List of cited chunk contents derived from document content.
+ { # Chunk content.
+ "content": "A String", # Chunk textual content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ "relatedQuestions": [ # Suggested related questions.
+ "A String",
+ ],
+ "state": "A String", # The state of the answer generation.
+ "steps": [ # Answer generation steps.
+ { # Step information.
+ "actions": [ # Actions.
+ { # Action.
+ "observation": { # Observation. # Observation.
+ "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+ {
+ "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+ { # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+ { # Snippet information.
+ "snippet": "A String", # Snippet content.
+ "snippetStatus": "A String", # Status of the snippet defined by the search team.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ ],
+ },
+ "searchAction": { # Search action. # Search action.
+ "query": "A String", # The query to search.
+ },
+ },
+ ],
+ "description": "A String", # The description of the step.
+ "state": "A String", # The state of the step.
+ "thought": "A String", # The thought of the step.
+ },
+ ],
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
new file mode 100644
index 00000000000..a9fa899e5e3
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
@@ -0,0 +1,319 @@
+
+
+
+Discovery Engine API . projects . locations . collections . dataStores . sessions
+Instance Methods
+
+ answers()
+
+Returns the answers Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Gets a Session.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all Sessions by their parent DataStore.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, x__xgafv=None)
+ Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+ parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+ name: string, Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a Session.
+
+Args:
+ name: string, Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all Sessions by their parent DataStore.
+
+Args:
+ parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+ filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+ orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time"
+ pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+ pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListSessions method.
+ "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+ "sessions": [ # All the Sessions for a given data store.
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+ name: string, Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ updateMask: string, Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.suggestionDenyListEntries.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.suggestionDenyListEntries.html
index fbb832705b2..a2135d9ec64 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.suggestionDenyListEntries.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.suggestionDenyListEntries.html
@@ -100,8 +100,8 @@ Method Details
{ # Request message for CompletionService.ImportSuggestionDenyListEntries method.
"gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line.
- "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
- "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+ "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+ "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
"A String",
],
},
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html
index 64185cd8434..f7854fa13fe 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html
@@ -82,7 +82,7 @@ Instance Methods
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
import_(parent, body=None, x__xgafv=None)
-Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
+Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
write(parent, body=None, x__xgafv=None)
Writes a single user event.
@@ -122,7 +122,7 @@ Method Details
import_(parent, body=None, x__xgafv=None)
- Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
+ Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
Args:
parent: string, Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` (required)
@@ -146,14 +146,14 @@ Method Details
"gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
},
"gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
- "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
- "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+ "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+ "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
"A String",
],
},
"inlineSource": { # The inline source for the input config for ImportUserEvents method. # The Inline source for the input content for UserEvents.
"userEvents": [ # Required. A list of user events to import. Recommended max of 10k items.
- { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+ { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -177,7 +177,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -209,7 +209,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -268,7 +268,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+{ # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -292,7 +292,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -324,7 +324,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -350,7 +350,7 @@ Method Details
Returns:
An object of the form:
- { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+ { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -374,7 +374,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -406,7 +406,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html
index f712b99ac73..9aeca320d29 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html
@@ -128,7 +128,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -234,7 +234,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -295,7 +295,7 @@ Method Details
"userPseudoId": "A String", # A unique identifier for tracking users.
},
"reply": { # Defines a reply message to user. # Answer to the current query.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -341,7 +341,7 @@ Method Details
},
"searchResults": [ # Search Results.
{ # Represents the search results.
- "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+ "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -381,7 +381,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -456,7 +456,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -556,7 +556,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -644,7 +644,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -738,7 +738,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -814,7 +814,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
index f3da22a125e..142ee0fa637 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
@@ -89,6 +89,11 @@ Instance Methods
Returns the servingConfigs Resource.
+
+ sessions()
+
+Returns the sessions Resource.
+
Close httplib2 connections.
@@ -146,7 +151,7 @@ Method Details
"A String",
],
"displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
- "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
+ "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.
"name": "A String", # Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -258,7 +263,7 @@ Method Details
"A String",
],
"displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
- "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
+ "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.
"name": "A String", # Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -311,7 +316,7 @@ Method Details
"A String",
],
"displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
- "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
+ "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.
"name": "A String", # Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -371,7 +376,7 @@ Method Details
"A String",
],
"displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
- "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
+ "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.
"name": "A String", # Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -413,7 +418,7 @@ Method Details
"A String",
],
"displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
- "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
+ "industryVertical": "A String", # The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.
"name": "A String", # Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"searchAddOns": [ # The add-on that this search engine enables.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
index a63ed21f8fb..da30042b1b7 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . collections . engines . servingConfigs
Instance Methods
+
+ answer(servingConfig, body=None, x__xgafv=None)
+Answer query method.
Close httplib2 connections.
@@ -87,6 +90,224 @@ Instance Methods
search_next()
Retrieves the next page of results.
Method Details
+
+ answer(servingConfig, body=None, x__xgafv=None)
+ Answer query method.
+
+Args:
+ servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+ "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+ "answerLanguageCode": "A String", # Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+ "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.
+ "ignoreNonAnswerSeekingQuery": True or False, # Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+ "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+ "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+ "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+ },
+ "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+ "preamble": "A String", # Customized preamble.
+ },
+ },
+ "asynchronousMode": True or False, # Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
+ "query": { # Defines a user inputed query. # Required. Current user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+ "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+ "types": [ # Enabled query classification types.
+ "A String",
+ ],
+ },
+ "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+ "disable": True or False, # Disable query rephraser.
+ },
+ },
+ "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+ "enable": True or False, # Enable related questions feature if true.
+ },
+ "safetySpec": { # Safety specification. # Model specification.
+ "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+ },
+ "searchSpec": { # Search specification. # Search specification.
+ "searchParams": { # Search parameters. # Search parameters.
+ "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+ "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+ { # Boost applies to documents which match a condition.
+ "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+ "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+ },
+ ],
+ },
+ "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+ "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+ },
+ "searchResultList": { # Search result list. # Search result list.
+ "searchResults": [ # Search results.
+ { # Search result.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "document": "A String", # Document resource name.
+ "documentContexts": [ # List of document contexts.
+ { # Document context.
+ "content": "A String", # Document content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "extractiveAnswers": [ # List of extractive answers.
+ { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+ "content": "A String", # Extractive answer content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "extractiveSegments": [ # List of extractive segments.
+ { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+ "content": "A String", # Extractive segment content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ },
+ },
+ "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.
+ "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ConversationalSearchService.AnswerQuery method.
+ "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+ "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+ "A String",
+ ],
+ "answerText": "A String", # The textual answer.
+ "citations": [ # Citations.
+ { # Citation info for a segment.
+ "endIndex": "A String", # End of the attributed segment, exclusive.
+ "sources": [ # Citation sources for the attributed segment.
+ { # Citation source.
+ "referenceId": "A String", # ID of the citation source.
+ },
+ ],
+ "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+ },
+ ],
+ "completeTime": "A String", # Output only. Answer completed timestamp.
+ "createTime": "A String", # Output only. Answer creation timestamp.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+ "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+ "queryClassificationInfo": [ # Query classification information.
+ { # Query classification information.
+ "positive": True or False, # Classification output.
+ "type": "A String", # Query classification type.
+ },
+ ],
+ },
+ "references": [ # References.
+ { # Reference.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "documentMetadata": { # Document metadata. # Document metadata.
+ "document": "A String", # Document resource name.
+ "pageIdentifier": "A String", # Page identifier.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "chunkContents": [ # List of cited chunk contents derived from document content.
+ { # Chunk content.
+ "content": "A String", # Chunk textual content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ "relatedQuestions": [ # Suggested related questions.
+ "A String",
+ ],
+ "state": "A String", # The state of the answer generation.
+ "steps": [ # Answer generation steps.
+ { # Step information.
+ "actions": [ # Actions.
+ { # Action.
+ "observation": { # Observation. # Observation.
+ "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+ {
+ "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+ { # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+ { # Snippet information.
+ "snippet": "A String", # Snippet content.
+ "snippetStatus": "A String", # Status of the snippet defined by the search team.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ ],
+ },
+ "searchAction": { # Search action. # Search action.
+ "query": "A String", # The query to search.
+ },
+ },
+ ],
+ "description": "A String", # The description of the step.
+ "state": "A String", # The state of the step.
+ "thought": "A String", # The thought of the step.
+ },
+ ],
+ },
+ "answerQueryToken": "A String", # A global unique ID used for logging.
+ "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+ },
+}
+
+
close()
Close httplib2 connections.
@@ -97,17 +318,17 @@ Method Details
Makes a recommendation, which requires a contextual user event.
Args:
- servingConfig: string, Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. (required)
+ servingConfig: string, Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for Recommend method.
- "filter": "A String", # Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
- "pageSize": 42, # Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
- "params": { # Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
+ "filter": "A String", # Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
+ "pageSize": 42, # Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.
+ "params": { # Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
"a_key": "",
},
- "userEvent": { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.
+ "userEvent": { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website. # Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -131,7 +352,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -163,7 +384,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -183,7 +404,7 @@ Method Details
"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
"a_key": "A String",
},
- "validateOnly": True or False, # Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
+ "validateOnly": True or False, # Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
}
x__xgafv: string, V1 error format.
@@ -221,7 +442,7 @@ Method Details
},
},
"id": "A String", # Resource ID of the recommended Document.
- "metadata": { # Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.
+ "metadata": { # Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.
"a_key": "",
},
},
@@ -240,7 +461,7 @@ Method Details
The object takes the form of:
{ # Request message for SearchService.Search method.
- "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+ "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
{ # Boost applies to documents which match a condition.
"boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
@@ -278,8 +499,8 @@ Method Details
"useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
},
},
- "dataStoreSpecs": [ # A list of data store specs to apply on a search call.
- { # A struct to define data stores to filter on in a search call.
+ "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+ { # A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
},
],
@@ -291,7 +512,7 @@ Method Details
],
"facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
"caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
- "contains": [ # Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+ "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
"A String",
],
"intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
@@ -311,7 +532,7 @@ Method Details
"A String",
],
},
- "limit": 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
+ "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -322,7 +543,7 @@ Method Details
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
"pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
"pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
- "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1
+ "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
"a_key": "",
},
"query": "A String", # Raw search query.
@@ -332,7 +553,7 @@ Method Details
},
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
- "mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.
+ "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
},
"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
@@ -358,7 +579,7 @@ Method Details
"facets": [ # Results of facets requested by user.
{ # A facet result.
"dynamicFacet": True or False, # Whether the facet is dynamically generated.
- "key": "A String", # The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.
+ "key": "A String", # The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key.
"values": [ # The facet values for this field.
{ # A facet value which contains value names and their count.
"count": "A String", # Number of items that have this facet value.
@@ -381,7 +602,7 @@ Method Details
"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
"results": [ # A list of matched documents. The order represents the ranking.
{ # Represents the search results.
- "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+ "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -403,7 +624,7 @@ Method Details
"id": "A String", # Document.id of the searched Document.
},
],
- "summary": { # Summary of the top N search result specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
+ "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html
new file mode 100644
index 00000000000..07ddeff4121
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html
@@ -0,0 +1,199 @@
+
+
+
+Discovery Engine API . projects . locations . collections . engines . sessions . answers
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+Gets a Answer.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets a Answer.
+
+Args:
+ name: string, Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an answer.
+ "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+ "A String",
+ ],
+ "answerText": "A String", # The textual answer.
+ "citations": [ # Citations.
+ { # Citation info for a segment.
+ "endIndex": "A String", # End of the attributed segment, exclusive.
+ "sources": [ # Citation sources for the attributed segment.
+ { # Citation source.
+ "referenceId": "A String", # ID of the citation source.
+ },
+ ],
+ "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+ },
+ ],
+ "completeTime": "A String", # Output only. Answer completed timestamp.
+ "createTime": "A String", # Output only. Answer creation timestamp.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+ "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+ "queryClassificationInfo": [ # Query classification information.
+ { # Query classification information.
+ "positive": True or False, # Classification output.
+ "type": "A String", # Query classification type.
+ },
+ ],
+ },
+ "references": [ # References.
+ { # Reference.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "documentMetadata": { # Document metadata. # Document metadata.
+ "document": "A String", # Document resource name.
+ "pageIdentifier": "A String", # Page identifier.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "chunkContents": [ # List of cited chunk contents derived from document content.
+ { # Chunk content.
+ "content": "A String", # Chunk textual content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ "relatedQuestions": [ # Suggested related questions.
+ "A String",
+ ],
+ "state": "A String", # The state of the answer generation.
+ "steps": [ # Answer generation steps.
+ { # Step information.
+ "actions": [ # Actions.
+ { # Action.
+ "observation": { # Observation. # Observation.
+ "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+ {
+ "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+ { # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+ { # Snippet information.
+ "snippet": "A String", # Snippet content.
+ "snippetStatus": "A String", # Status of the snippet defined by the search team.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ ],
+ },
+ "searchAction": { # Search action. # Search action.
+ "query": "A String", # The query to search.
+ },
+ },
+ ],
+ "description": "A String", # The description of the step.
+ "state": "A String", # The state of the step.
+ "thought": "A String", # The thought of the step.
+ },
+ ],
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
new file mode 100644
index 00000000000..41a2ec3b0f9
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
@@ -0,0 +1,319 @@
+
+
+
+Discovery Engine API . projects . locations . collections . engines . sessions
+Instance Methods
+
+ answers()
+
+Returns the answers Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Gets a Session.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all Sessions by their parent DataStore.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, x__xgafv=None)
+ Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+ parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+ name: string, Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a Session.
+
+Args:
+ name: string, Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all Sessions by their parent DataStore.
+
+Args:
+ parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+ filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+ orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time"
+ pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+ pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListSessions method.
+ "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+ "sessions": [ # All the Sessions for a given data store.
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+ name: string, Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ updateMask: string, Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html
index 701e5f7a522..32019f190d4 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html
@@ -88,7 +88,7 @@ Instance Methods
Gets a Document.
import_(parent, body=None, x__xgafv=None)
-Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
+Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Gets a list of Documents.
@@ -136,7 +136,7 @@ Method Details
},
}
- documentId: string, Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+ documentId: string, Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -221,7 +221,7 @@ Method Details
import_(parent, body=None, x__xgafv=None)
- Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
+ Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. (required)
@@ -281,14 +281,14 @@ Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.
},
"firestoreSource": { # Firestore source import data from. # Firestore input source.
- "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.
+ "collectionId": "A String", # Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.
"databaseId": "A String", # Required. The Firestore database to copy the data from with a length limit of 256 characters.
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
"projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
},
"gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
- "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
- "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+ "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+ "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
"A String",
],
},
@@ -362,7 +362,7 @@ Method Details
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. (required)
- pageSize: integer, Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+ pageSize: integer, Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
pageToken: string, A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
x__xgafv: string, V1 error format.
Allowed values
@@ -441,8 +441,8 @@ Method Details
},
}
- allowMissing: boolean, If set to true, and the Document is not found, a new Document will be created.
- updateMask: string, Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
+ allowMissing: boolean, If set to `true` and the Document is not found, a new Document is be created.
+ updateMask: string, Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.operations.html
index c7bc179ca08..989295ed37c 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.operations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.operations.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . dataStores . branches . operations
Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -87,6 +90,30 @@ Instance Methods
list_next()
Retrieves the next page of results.
Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html
index 051cd07fdef..18c81b0db39 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html
@@ -128,7 +128,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -234,7 +234,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -295,7 +295,7 @@ Method Details
"userPseudoId": "A String", # A unique identifier for tracking users.
},
"reply": { # Defines a reply message to user. # Answer to the current query.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -341,7 +341,7 @@ Method Details
},
"searchResults": [ # Search Results.
{ # Represents the search results.
- "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+ "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -381,7 +381,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -456,7 +456,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -556,7 +556,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -644,7 +644,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -738,7 +738,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
@@ -814,7 +814,7 @@ Method Details
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
- "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
+ "summary": { # Summary of the top N search results specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
index 997b192db37..f57c9ee0cab 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
@@ -104,6 +104,11 @@ Instance Methods
Returns the servingConfigs Resource.
+
+ sessions()
+
+Returns the sessions Resource.
+
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.schemas.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.schemas.html
index 3edd440ff64..0faef62ba73 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.schemas.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.schemas.html
@@ -118,7 +118,7 @@ Method Details
},
}
- schemaId: string, Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+ schemaId: string, Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,7 +212,7 @@ Method Details
Args:
parent: string, Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. (required)
- pageSize: integer, The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageSize: integer, The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.
pageToken: string, A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
@@ -267,7 +267,7 @@ Method Details
},
}
- allowMissing: boolean, If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.
+ allowMissing: boolean, If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
index d0caf7c823f..ac04d6324a0 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . dataStores . servingConfigs
Instance Methods
+
+ answer(servingConfig, body=None, x__xgafv=None)
+Answer query method.
Close httplib2 connections.
@@ -87,6 +90,224 @@ Instance Methods
search_next()
Retrieves the next page of results.
Method Details
+
+ answer(servingConfig, body=None, x__xgafv=None)
+ Answer query method.
+
+Args:
+ servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+ "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+ "answerLanguageCode": "A String", # Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+ "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.
+ "ignoreNonAnswerSeekingQuery": True or False, # Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+ "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+ "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+ "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+ },
+ "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+ "preamble": "A String", # Customized preamble.
+ },
+ },
+ "asynchronousMode": True or False, # Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
+ "query": { # Defines a user inputed query. # Required. Current user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+ "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+ "types": [ # Enabled query classification types.
+ "A String",
+ ],
+ },
+ "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+ "disable": True or False, # Disable query rephraser.
+ },
+ },
+ "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+ "enable": True or False, # Enable related questions feature if true.
+ },
+ "safetySpec": { # Safety specification. # Model specification.
+ "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+ },
+ "searchSpec": { # Search specification. # Search specification.
+ "searchParams": { # Search parameters. # Search parameters.
+ "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+ "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+ { # Boost applies to documents which match a condition.
+ "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+ "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+ },
+ ],
+ },
+ "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+ "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+ },
+ "searchResultList": { # Search result list. # Search result list.
+ "searchResults": [ # Search results.
+ { # Search result.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "document": "A String", # Document resource name.
+ "documentContexts": [ # List of document contexts.
+ { # Document context.
+ "content": "A String", # Document content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "extractiveAnswers": [ # List of extractive answers.
+ { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+ "content": "A String", # Extractive answer content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "extractiveSegments": [ # List of extractive segments.
+ { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+ "content": "A String", # Extractive segment content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ },
+ },
+ "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.
+ "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ConversationalSearchService.AnswerQuery method.
+ "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+ "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+ "A String",
+ ],
+ "answerText": "A String", # The textual answer.
+ "citations": [ # Citations.
+ { # Citation info for a segment.
+ "endIndex": "A String", # End of the attributed segment, exclusive.
+ "sources": [ # Citation sources for the attributed segment.
+ { # Citation source.
+ "referenceId": "A String", # ID of the citation source.
+ },
+ ],
+ "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+ },
+ ],
+ "completeTime": "A String", # Output only. Answer completed timestamp.
+ "createTime": "A String", # Output only. Answer creation timestamp.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+ "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+ "queryClassificationInfo": [ # Query classification information.
+ { # Query classification information.
+ "positive": True or False, # Classification output.
+ "type": "A String", # Query classification type.
+ },
+ ],
+ },
+ "references": [ # References.
+ { # Reference.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "documentMetadata": { # Document metadata. # Document metadata.
+ "document": "A String", # Document resource name.
+ "pageIdentifier": "A String", # Page identifier.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "chunkContents": [ # List of cited chunk contents derived from document content.
+ { # Chunk content.
+ "content": "A String", # Chunk textual content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ "relatedQuestions": [ # Suggested related questions.
+ "A String",
+ ],
+ "state": "A String", # The state of the answer generation.
+ "steps": [ # Answer generation steps.
+ { # Step information.
+ "actions": [ # Actions.
+ { # Action.
+ "observation": { # Observation. # Observation.
+ "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+ {
+ "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+ { # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+ { # Snippet information.
+ "snippet": "A String", # Snippet content.
+ "snippetStatus": "A String", # Status of the snippet defined by the search team.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ ],
+ },
+ "searchAction": { # Search action. # Search action.
+ "query": "A String", # The query to search.
+ },
+ },
+ ],
+ "description": "A String", # The description of the step.
+ "state": "A String", # The state of the step.
+ "thought": "A String", # The thought of the step.
+ },
+ ],
+ },
+ "answerQueryToken": "A String", # A global unique ID used for logging.
+ "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+ },
+}
+
+
close()
Close httplib2 connections.
@@ -97,17 +318,17 @@ Method Details
Makes a recommendation, which requires a contextual user event.
Args:
- servingConfig: string, Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. (required)
+ servingConfig: string, Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for Recommend method.
- "filter": "A String", # Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
- "pageSize": 42, # Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
- "params": { # Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
+ "filter": "A String", # Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
+ "pageSize": 42, # Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.
+ "params": { # Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
"a_key": "",
},
- "userEvent": { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.
+ "userEvent": { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website. # Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -131,7 +352,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -163,7 +384,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -183,7 +404,7 @@ Method Details
"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
"a_key": "A String",
},
- "validateOnly": True or False, # Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
+ "validateOnly": True or False, # Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
}
x__xgafv: string, V1 error format.
@@ -221,7 +442,7 @@ Method Details
},
},
"id": "A String", # Resource ID of the recommended Document.
- "metadata": { # Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.
+ "metadata": { # Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.
"a_key": "",
},
},
@@ -240,7 +461,7 @@ Method Details
The object takes the form of:
{ # Request message for SearchService.Search method.
- "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+ "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
{ # Boost applies to documents which match a condition.
"boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
@@ -278,8 +499,8 @@ Method Details
"useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
},
},
- "dataStoreSpecs": [ # A list of data store specs to apply on a search call.
- { # A struct to define data stores to filter on in a search call.
+ "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+ { # A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
},
],
@@ -291,7 +512,7 @@ Method Details
],
"facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
"caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
- "contains": [ # Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+ "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
"A String",
],
"intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
@@ -311,7 +532,7 @@ Method Details
"A String",
],
},
- "limit": 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
+ "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -322,7 +543,7 @@ Method Details
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
"pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
"pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
- "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1
+ "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
"a_key": "",
},
"query": "A String", # Raw search query.
@@ -332,7 +553,7 @@ Method Details
},
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
- "mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.
+ "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
},
"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
@@ -358,7 +579,7 @@ Method Details
"facets": [ # Results of facets requested by user.
{ # A facet result.
"dynamicFacet": True or False, # Whether the facet is dynamically generated.
- "key": "A String", # The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.
+ "key": "A String", # The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key.
"values": [ # The facet values for this field.
{ # A facet value which contains value names and their count.
"count": "A String", # Number of items that have this facet value.
@@ -381,7 +602,7 @@ Method Details
"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
"results": [ # A list of matched documents. The order represents the ranking.
{ # Represents the search results.
- "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+ "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -403,7 +624,7 @@ Method Details
"id": "A String", # Document.id of the searched Document.
},
],
- "summary": { # Summary of the top N search result specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
+ "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html
new file mode 100644
index 00000000000..46c65eea803
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html
@@ -0,0 +1,199 @@
+
+
+
+Discovery Engine API . projects . locations . dataStores . sessions . answers
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+Gets a Answer.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets a Answer.
+
+Args:
+ name: string, Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an answer.
+ "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+ "A String",
+ ],
+ "answerText": "A String", # The textual answer.
+ "citations": [ # Citations.
+ { # Citation info for a segment.
+ "endIndex": "A String", # End of the attributed segment, exclusive.
+ "sources": [ # Citation sources for the attributed segment.
+ { # Citation source.
+ "referenceId": "A String", # ID of the citation source.
+ },
+ ],
+ "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+ },
+ ],
+ "completeTime": "A String", # Output only. Answer completed timestamp.
+ "createTime": "A String", # Output only. Answer creation timestamp.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+ "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+ "queryClassificationInfo": [ # Query classification information.
+ { # Query classification information.
+ "positive": True or False, # Classification output.
+ "type": "A String", # Query classification type.
+ },
+ ],
+ },
+ "references": [ # References.
+ { # Reference.
+ "chunkInfo": { # Chunk information. # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "documentMetadata": { # Document metadata. # Document metadata.
+ "document": "A String", # Document resource name.
+ "pageIdentifier": "A String", # Page identifier.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+ "chunkContents": [ # List of cited chunk contents derived from document content.
+ { # Chunk content.
+ "content": "A String", # Chunk textual content.
+ "pageIdentifier": "A String", # Page identifier.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ },
+ ],
+ "relatedQuestions": [ # Suggested related questions.
+ "A String",
+ ],
+ "state": "A String", # The state of the answer generation.
+ "steps": [ # Answer generation steps.
+ { # Step information.
+ "actions": [ # Actions.
+ { # Action.
+ "observation": { # Observation. # Observation.
+ "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+ {
+ "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+ { # Chunk information.
+ "chunk": "A String", # Chunk resource name.
+ "content": "A String", # Chunk textual content.
+ "relevanceScore": 3.14, # Relevance score.
+ },
+ ],
+ "document": "A String", # Document resource name.
+ "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+ { # Snippet information.
+ "snippet": "A String", # Snippet content.
+ "snippetStatus": "A String", # Status of the snippet defined by the search team.
+ },
+ ],
+ "title": "A String", # Title.
+ "uri": "A String", # URI for the document.
+ },
+ ],
+ },
+ "searchAction": { # Search action. # Search action.
+ "query": "A String", # The query to search.
+ },
+ },
+ ],
+ "description": "A String", # The description of the step.
+ "state": "A String", # The state of the step.
+ "thought": "A String", # The thought of the step.
+ },
+ ],
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html
new file mode 100644
index 00000000000..7c44107d19e
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html
@@ -0,0 +1,319 @@
+
+
+
+Discovery Engine API . projects . locations . dataStores . sessions
+Instance Methods
+
+ answers()
+
+Returns the answers Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Gets a Session.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all Sessions by their parent DataStore.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, x__xgafv=None)
+ Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+ parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+ name: string, Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a Session.
+
+Args:
+ name: string, Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all Sessions by their parent DataStore.
+
+Args:
+ parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+ filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+ orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time"
+ pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+ pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListSessions method.
+ "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+ "sessions": [ # All the Sessions for a given data store.
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+ name: string, Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ updateMask: string, Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # External session proto definition.
+ "endTime": "A String", # Output only. The time the session finished.
+ "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+ "startTime": "A String", # Output only. The time the session started.
+ "state": "A String", # The state of the session.
+ "turns": [ # Turns.
+ { # Represents a turn, including a query from the user and a answer from service.
+ "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.
+ "query": { # Defines a user inputed query. # The user query.
+ "queryId": "A String", # Unique Id for the query.
+ "text": "A String", # Plain text.
+ },
+ },
+ ],
+ "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.suggestionDenyListEntries.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.suggestionDenyListEntries.html
index 9047da2a01c..3d62c8b1fe9 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.suggestionDenyListEntries.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.suggestionDenyListEntries.html
@@ -100,8 +100,8 @@ Method Details
{ # Request message for CompletionService.ImportSuggestionDenyListEntries method.
"gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line.
- "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
- "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+ "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+ "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
"A String",
],
},
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html
index f3554b3b14e..e663fb909bd 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html
@@ -82,7 +82,7 @@ Instance Methods
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
import_(parent, body=None, x__xgafv=None)
-Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
+Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
write(parent, body=None, x__xgafv=None)
Writes a single user event.
@@ -122,7 +122,7 @@ Method Details
import_(parent, body=None, x__xgafv=None)
- Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
+ Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
Args:
parent: string, Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` (required)
@@ -146,14 +146,14 @@ Method Details
"gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
},
"gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
- "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
- "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+ "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+ "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
"A String",
],
},
"inlineSource": { # The inline source for the input config for ImportUserEvents method. # The Inline source for the input content for UserEvents.
"userEvents": [ # Required. A list of user events to import. Recommended max of 10k items.
- { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+ { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -177,7 +177,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -209,7 +209,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -268,7 +268,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+{ # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -292,7 +292,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -324,7 +324,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -350,7 +350,7 @@ Method Details
Returns:
An object of the form:
- { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+ { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -374,7 +374,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -406,7 +406,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html
new file mode 100644
index 00000000000..b2d21a8426f
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html
@@ -0,0 +1,150 @@
+
+
+
+Discovery Engine API . projects . locations . groundingConfigs
+Instance Methods
+
+ check(groundingConfig, body=None, x__xgafv=None)
+Performs a grounding check.
+
+ close()
+Close httplib2 connections.
+Method Details
+
+ check(groundingConfig, body=None, x__xgafv=None)
+ Performs a grounding check.
+
+Args:
+ groundingConfig: string, Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for GroundedGenerationService.CheckGrounding method.
+ "answerCandidate": "A String", # Answer candidate to check. Can have a maximum length of 1024 characters.
+ "facts": [ # List of facts for the grounding check. We support up to 200 facts.
+ { # Grounding Fact.
+ "attributes": { # Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.
+ "a_key": "A String",
+ },
+ "factText": "A String", # Text content of the fact. Can be at most 10K characters long.
+ },
+ ],
+ "groundingSpec": { # Specification for the grounding check. # Configuration of the grounding check.
+ "citationThreshold": 3.14, # The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.
+ },
+ "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+ "a_key": "A String",
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for the GroundedGenerationService.CheckGrounding method.
+ "citedChunks": [ # List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
+ { # Fact Chunk.
+ "chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long.
+ "index": 42, # The index of this chunk. Currently, only used for the streaming mode.
+ "source": "A String", # Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.
+ "sourceMetadata": { # More fine-grained information for the source reference.
+ "a_key": "A String",
+ },
+ },
+ ],
+ "claims": [ # Claim texts and citation info across all claims in the answer candidate.
+ { # Text and citation info for a claim in the answer candidate.
+ "citationIndices": [ # A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.
+ 42,
+ ],
+ "claimText": "A String", # Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
+ "endPos": 42, # Position indicating the end of the claim in the answer candidate, exclusive.
+ "groundingCheckRequired": True or False, # Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.
+ "startPos": 42, # Position indicating the start of the claim in the answer candidate, measured in bytes.
+ },
+ ],
+ "supportScore": 3.14, # The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html
index 83d8271c81a..8396d5bdb2a 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.html
@@ -84,11 +84,21 @@ Instance Methods
Returns the dataStores Resource.
+
+Returns the groundingConfigs Resource.
+
Returns the operations Resource.
+
+ rankingConfigs()
+
+Returns the rankingConfigs Resource.
+
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.rankingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.rankingConfigs.html
new file mode 100644
index 00000000000..00a327e2e50
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1.projects.locations.rankingConfigs.html
@@ -0,0 +1,133 @@
+
+
+
+Discovery Engine API . projects . locations . rankingConfigs
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ rank(rankingConfig, body=None, x__xgafv=None)
+Ranks a list of text records based on the given input query.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ rank(rankingConfig, body=None, x__xgafv=None)
+ Ranks a list of text records based on the given input query.
+
+Args:
+ rankingConfig: string, Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for RankService.Rank method.
+ "ignoreRecordDetailsInResponse": True or False, # If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
+ "model": "A String", # The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.
+ "query": "A String", # The query to use.
+ "records": [ # Required. A list of records to rank. At most 200 records to rank.
+ { # Record message for RankService.Rank method.
+ "content": "A String", # The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
+ "id": "A String", # The unique ID to represent the record.
+ "score": 3.14, # The score of this record based on the given query and selected model.
+ "title": "A String", # The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
+ },
+ ],
+ "topN": 42, # The number of results to return. If this is unset or no bigger than zero, returns all results.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for RankService.Rank method.
+ "records": [ # A list of records sorted by descending score.
+ { # Record message for RankService.Rank method.
+ "content": "A String", # The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
+ "id": "A String", # The unique ID to represent the record.
+ "score": 3.14, # The score of this record based on the given query and selected model.
+ "title": "A String", # The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
+ },
+ ],
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html
index a610f89210e..47d430d50de 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html
@@ -95,7 +95,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+{ # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -119,7 +119,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -151,7 +151,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
@@ -177,7 +177,7 @@ Method Details
Returns:
An object of the form:
- { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
+ { # UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
"attributes": { # Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
"a_key": { # A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
"numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -201,7 +201,7 @@ Method Details
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
"A String",
],
- "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
+ "quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
"uri": "A String", # The Document URI - only allowed for website data stores.
},
],
@@ -233,7 +233,7 @@ Method Details
"searchQuery": "A String", # The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
},
"sessionId": "A String", # A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.
- "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.
+ "tagIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.
"A String",
],
"transactionInfo": { # A transaction represents the entire purchase transaction. # The transaction metadata (if any) associated with this user event.
diff --git a/docs/dyn/discoveryengine_v1.projects.operations.html b/docs/dyn/discoveryengine_v1.projects.operations.html
index 5376b3db207..121d945389f 100644
--- a/docs/dyn/discoveryengine_v1.projects.operations.html
+++ b/docs/dyn/discoveryengine_v1.projects.operations.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . operations
Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -87,6 +90,30 @@ Instance Methods
list_next()
Retrieves the next page of results.
Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html
index 53d2dfe6429..774b9d73881 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html
@@ -132,6 +132,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
}
@@ -179,6 +180,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
],
"nextPageToken": "A String", # A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.operations.html
index 10a4e53feb5..fc641c35a33 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.operations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.operations.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . collections . dataStores . branches . operations
Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -87,6 +90,30 @@ Instance Methods
list_next()
Retrieves the next page of results.
Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
index 8807442302d..1029a3726c7 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
@@ -408,6 +408,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
"document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
"aclInfo": { # ACL Information of the Document. # Access control information for the document.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
index d444890bf34..a53a0c16c1b 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
@@ -1136,6 +1136,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
"document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
"aclInfo": { # ACL Information of the Document. # Access control information for the document.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html
index baafcd199a7..15d7a1b3467 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html
@@ -408,6 +408,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
"document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
"aclInfo": { # ACL Information of the Document. # Access control information for the document.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
index 5bed845e857..9cc1d8aefee 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
@@ -1136,6 +1136,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
"document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
"aclInfo": { # ACL Information of the Document. # Access control information for the document.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html
index 1961b52de8e..fe277369010 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html
@@ -132,6 +132,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
}
@@ -179,6 +180,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
],
"nextPageToken": "A String", # A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.operations.html
index d2de5d17e42..f93b6970db4 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.operations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.operations.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . dataStores . branches . operations
Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -87,6 +90,30 @@ Instance Methods
list_next()
Retrieves the next page of results.
Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html
index 050be5ceba0..3fe4cf0f4a0 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html
@@ -408,6 +408,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
"document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
"aclInfo": { # ACL Information of the Document. # Access control information for the document.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
index a906fff1fb7..6b7ec22a2f2 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
@@ -1136,6 +1136,7 @@ Method Details
"pageEnd": 42, # The end page of the chunk.
"pageStart": 42, # The start page of the chunk.
},
+ "relevanceScore": 3.14, # Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse
},
"document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
"aclInfo": { # ACL Information of the Document. # Access control information for the document.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.operations.html
index c78077635f5..f9edb27aba7 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.operations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.operations.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . collections . dataStores . branches . operations
Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -87,6 +90,30 @@ Instance Methods
list_next()
Retrieves the next page of results.
Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.operations.html
index fac036b4182..52ede79624c 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.operations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.operations.html
@@ -74,6 +74,9 @@
Discovery Engine API . projects . locations . dataStores . branches . operations
Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -87,6 +90,30 @@ Instance Methods
list_next()
Retrieves the next page of results.
Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/dlp_v2.organizations.locations.connections.html b/docs/dyn/dlp_v2.organizations.locations.connections.html
index 187804cd044..ca02036bf04 100644
--- a/docs/dyn/dlp_v2.organizations.locations.connections.html
+++ b/docs/dyn/dlp_v2.organizations.locations.connections.html
@@ -95,7 +95,7 @@ Method Details
Args:
parent: string, Required. Parent name, typically an organization, without location. For example: `organizations/12345678`. (required)
- filter: string, Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR
+ filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR
pageSize: integer, Optional. Number of results per page, max 1000.
pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
x__xgafv: string, V1 error format.
@@ -110,7 +110,7 @@ Method Details
"connections": [ # List of connections that match the search query. Note that only a subset of the fields will be populated, and only "name" is guaranteed to be set. For full details of a Connection, call GetConnection with the name.
{ # A data connection to allow DLP to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
index e40e285fc02..c5133b9dfc1 100644
--- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
+++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
@@ -206,6 +206,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -238,21 +242,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -260,6 +266,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -368,6 +376,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -400,21 +412,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -422,6 +436,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -554,6 +570,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -586,21 +606,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -608,6 +630,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -727,6 +751,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -759,21 +787,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -781,6 +811,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -908,6 +940,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -940,21 +976,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -962,6 +1000,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -1071,6 +1111,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -1103,21 +1147,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -1125,6 +1171,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
index 9229b31fbf3..697a1e92320 100644
--- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
+++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
@@ -3244,7 +3244,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
index d54703d0797..9b09944bae0 100644
--- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
+++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
@@ -111,7 +111,7 @@ Method Details
The object takes the form of:
{ # Request message for CreateJobTrigger.
- "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
+ "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -462,7 +462,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -835,7 +835,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -1202,7 +1202,7 @@ Method Details
{ # Response message for ListJobTriggers.
"jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest.
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -1570,7 +1570,7 @@ Method Details
The object takes the form of:
{ # Request message for UpdateJobTrigger.
- "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value.
+ "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -1920,7 +1920,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
index aa72fdc6fd8..91e95fe594c 100644
--- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
+++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
@@ -260,6 +260,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -292,21 +296,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -314,6 +320,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -723,6 +731,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -755,21 +767,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -777,6 +791,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html
index 27d8d6f0667..81c96f41079 100644
--- a/docs/dyn/dlp_v2.projects.dlpJobs.html
+++ b/docs/dyn/dlp_v2.projects.dlpJobs.html
@@ -3745,7 +3745,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
@@ -7471,7 +7471,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
@@ -11191,7 +11191,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html
index 45550ce6dd0..163cd13f509 100644
--- a/docs/dyn/dlp_v2.projects.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.jobTriggers.html
@@ -3248,7 +3248,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
@@ -3828,7 +3828,7 @@ Method Details
The object takes the form of:
{ # Request message for CreateJobTrigger.
- "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
+ "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -4179,7 +4179,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -4552,7 +4552,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -4919,7 +4919,7 @@ Method Details
{ # Response message for ListJobTriggers.
"jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest.
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -5287,7 +5287,7 @@ Method Details
The object takes the form of:
{ # Request message for UpdateJobTrigger.
- "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value.
+ "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -5637,7 +5637,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
diff --git a/docs/dyn/dlp_v2.projects.locations.connections.html b/docs/dyn/dlp_v2.projects.locations.connections.html
index 4878f98b64f..9ca1f427ce1 100644
--- a/docs/dyn/dlp_v2.projects.locations.connections.html
+++ b/docs/dyn/dlp_v2.projects.locations.connections.html
@@ -119,7 +119,7 @@ Method Details
{ # Request message for CreateConnection.
"connection": { # A data connection to allow DLP to profile data in locations that require additional configuration. # Required. The connection resource.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
@@ -160,7 +160,7 @@ Method Details
{ # A data connection to allow DLP to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
@@ -225,7 +225,7 @@ Method Details
{ # A data connection to allow DLP to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
@@ -262,7 +262,7 @@ Method Details
Args:
parent: string, Required. Parent name, for example: `projects/project-id/locations/global`. (required)
- filter: string, Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR
+ filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR
pageSize: integer, Optional. Number of results per page, max 1000.
pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
x__xgafv: string, V1 error format.
@@ -277,7 +277,7 @@ Method Details
"connections": [ # List of connections.
{ # A data connection to allow DLP to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
@@ -337,7 +337,7 @@ Method Details
{ # Request message for UpdateConnection.
"connection": { # A data connection to allow DLP to profile data in locations that require additional configuration. # Required. The connection with new values for the relevant fields.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
@@ -379,7 +379,7 @@ Method Details
{ # A data connection to allow DLP to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
@@ -416,7 +416,7 @@ Method Details
Args:
parent: string, Required. Parent name, typically an organization, without location. For example: `organizations/12345678`. (required)
- filter: string, Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR
+ filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR
pageSize: integer, Optional. Number of results per page, max 1000.
pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
x__xgafv: string, V1 error format.
@@ -431,7 +431,7 @@ Method Details
"connections": [ # List of connections that match the search query. Note that only a subset of the fields will be populated, and only "name" is guaranteed to be set. For full details of a Connection, call GetConnection with the name.
{ # A data connection to allow DLP to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
- "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+ "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
index cf058246f95..708f69e848a 100644
--- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
+++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
@@ -206,6 +206,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -238,21 +242,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -260,6 +266,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -368,6 +376,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -400,21 +412,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -422,6 +436,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -554,6 +570,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -586,21 +606,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -608,6 +630,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -727,6 +751,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -759,21 +787,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -781,6 +811,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -908,6 +940,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -940,21 +976,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -962,6 +1000,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -1071,6 +1111,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -1103,21 +1147,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -1125,6 +1171,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
index a4fb858d280..8f534772815 100644
--- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
+++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
@@ -3751,7 +3751,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
@@ -7501,7 +7501,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
@@ -11309,7 +11309,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
index 2e34feb3f9b..ea382642f9d 100644
--- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
@@ -3251,7 +3251,7 @@ Method Details
},
},
],
- "numRowsProcessed": "A String", # Number of rows scanned post sampling and time filtering (Applicable for row based stores such as BigQuery).
+ "numRowsProcessed": "A String", # Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
"processedBytes": "A String", # Total size in bytes that were processed.
"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process.
},
@@ -3831,7 +3831,7 @@ Method Details
The object takes the form of:
{ # Request message for CreateJobTrigger.
- "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
+ "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -4182,7 +4182,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -4555,7 +4555,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -5010,7 +5010,7 @@ Method Details
{ # Response message for ListJobTriggers.
"jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest.
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -5378,7 +5378,7 @@ Method Details
The object takes the form of:
{ # Request message for UpdateJobTrigger.
- "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value.
+ "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
@@ -5728,7 +5728,7 @@ Method Details
Returns:
An object of the form:
- { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
+ { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.
"createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
"description": "A String", # User provided description (max 256 chars)
"displayName": "A String", # Display name (max 100 chars)
diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
index 40f312584e2..b2463cd095e 100644
--- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
+++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
@@ -260,6 +260,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -292,21 +296,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -314,6 +320,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
@@ -723,6 +731,10 @@ Method Details
"filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
"otherTables": { # Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target. # Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
+ "tableReference": { # Message defining the location of a BigQuery table with the projectId inferred from the parent project. # The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
+ "datasetId": "A String", # Dataset ID of the table.
+ "tableId": "A String", # Name of the table.
+ },
"tables": { # Specifies a collection of BigQuery tables. Used for Discovery. # A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
"includeRegexes": { # A collection of regular expressions to determine what tables to match against. # A collection of regular expressions to match a BigQuery table against.
"patterns": [ # A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
@@ -755,21 +767,23 @@ Method Details
"databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match.
"databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.
"instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match.
- "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.
+ "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
},
],
},
},
"databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference).
- "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id.
- "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id.
+ "database": "A String", # Required. Name of a database within the instance.
+ "databaseResource": "A String", # Required. Name of a database resource, for example, a table within the database.
+ "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL instance ID.
+ "projectId": "A String", # Required. If within a project-level config, then this must match the config's project ID.
},
"others": { # Match database resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
},
},
"generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
"refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never.
- "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
+ "schemaModifiedCadence": { # How frequently to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed.
"frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
"types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS.
"A String",
@@ -777,6 +791,8 @@ Method Details
},
},
},
+ "secretsTarget": { # Discovery target for credentials and secrets in Cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan Cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of Secrets and Credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
+ },
},
],
"updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig.
diff --git a/docs/dyn/drive_v3.about.html b/docs/dyn/drive_v3.about.html
index 4283db84799..11e678d241e 100644
--- a/docs/dyn/drive_v3.about.html
+++ b/docs/dyn/drive_v3.about.html
@@ -128,9 +128,9 @@ Method Details
"a_key": "A String",
},
"maxUploadSize": "A String", # The maximum upload size in bytes.
- "storageQuota": { # The user's storage quota limits and usage. All fields are measured in bytes.
- "limit": "A String", # The usage limit, if applicable. This will not be present if the user has unlimited storage.
- "usage": "A String", # The total usage across all services.
+ "storageQuota": { # The user's storage quota limits and usage. For users that are part of an organization with pooled storage, information about the limit and usage across all services is for the organization, rather than the individual user. All fields are measured in bytes.
+ "limit": "A String", # The usage limit, if applicable. This will not be present if the user has unlimited storage. For users that are part of an organization with pooled storage, this is the limit for the organization, rather than the individual user.
+ "usage": "A String", # The total usage across all services. For users that are part of an organization with pooled storage, this is the usage across all services for the organization, rather than the individual user.
"usageInDrive": "A String", # The usage by all files in Google Drive.
"usageInDriveTrash": "A String", # The usage by trashed files in Google Drive.
},
diff --git a/docs/dyn/eventarc_v1.projects.locations.triggers.html b/docs/dyn/eventarc_v1.projects.locations.triggers.html
index 4625841b869..d4e4c9586cf 100644
--- a/docs/dyn/eventarc_v1.projects.locations.triggers.html
+++ b/docs/dyn/eventarc_v1.projects.locations.triggers.html
@@ -145,8 +145,8 @@ Method Details
"httpEndpoint": { # Represents a HTTP endpoint destination. # An HTTP endpoint destination described by an URI.
"uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
},
- "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
- "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the destination VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+ "networkConfig": { # Network Configuration that can be inherited by other protos. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
+ "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the customer's VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
},
"workflow": "A String", # The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the trigger. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
},
@@ -284,8 +284,8 @@ Method Details
"httpEndpoint": { # Represents a HTTP endpoint destination. # An HTTP endpoint destination described by an URI.
"uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
},
- "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
- "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the destination VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+ "networkConfig": { # Network Configuration that can be inherited by other protos. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
+ "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the customer's VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
},
"workflow": "A String", # The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the trigger. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
},
@@ -410,8 +410,8 @@ Method Details
"httpEndpoint": { # Represents a HTTP endpoint destination. # An HTTP endpoint destination described by an URI.
"uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
},
- "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
- "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the destination VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+ "networkConfig": { # Network Configuration that can be inherited by other protos. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
+ "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the customer's VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
},
"workflow": "A String", # The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the trigger. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
},
@@ -495,8 +495,8 @@ Method Details
"httpEndpoint": { # Represents a HTTP endpoint destination. # An HTTP endpoint destination described by an URI.
"uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
},
- "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
- "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the destination VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+ "networkConfig": { # Network Configuration that can be inherited by other protos. # Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
+ "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the customer's VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
},
"workflow": "A String", # The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the trigger. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
},
diff --git a/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html b/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html
index 6f03fb0aa29..c0211d601c2 100644
--- a/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html
+++ b/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html
@@ -111,7 +111,8 @@ Method Details
"analyticsLabel": "A String", # The analytics label associated with the messages sent. All messages sent without an analytics label will be grouped together in a single entry.
"appId": "A String", # The app ID to which the messages were sent.
"data": { # Data detailing messaging delivery # The data for the specified appId, date, and analyticsLabel.
- "countMessagesAccepted": "A String", # Count of messages accepted by FCM intended to Android devices. The targeted device must have opted in to the collection of usage and diagnostic information.
+ "countMessagesAccepted": "A String", # Count of messages accepted by FCM intended for Android devices. The targeted device must have opted in to the collection of usage and diagnostic information.
+ "countNotificationsAccepted": "A String", # Count of notifications accepted by FCM intended for Android devices. The targeted device must have opted in to the collection of usage and diagnostic information.
"deliveryPerformancePercents": { # Overview of delivery performance for messages that were successfully delivered. All percentages are calculated with countMessagesAccepted as the denominator. These categories are not mutually exclusive; a message can be delayed for multiple reasons. # Additional information about delivery performance for messages that were successfully delivered.
"delayedDeviceDoze": 3.14, # The percentage of accepted messages that were delayed because the device was in doze mode. Only [normal priority messages](https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message) should be delayed due to doze mode.
"delayedDeviceOffline": 3.14, # The percentage of accepted messages that were delayed because the target device was not connected at the time of sending. These messages were eventually delivered when the device reconnected.
@@ -129,6 +130,14 @@ Method Details
"droppedTooManyPendingMessages": 3.14, # The percentage of accepted messages that were dropped due to [too many undelivered non-collapsible messages](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages). Specifically, each app instance can only have 100 pending messages stored on our servers for a device which is disconnected. When that device reconnects, those messages are delivered. When there are more than the maximum pending messages, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages.
"pending": 3.14, # The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the message was sent to FCM). A portion of these messages will be delivered the next day when the device connects but others may be destined to devices that ultimately never reconnect.
},
+ "proxyNotificationInsightPercents": { # Additional information about proxy notification delivery. All percentages are calculated with countNotificationsAccepted as the denominator. # Additional insights about proxy notification delivery.
+ "failed": 3.14, # The percentage of accepted notifications that failed to be proxied. This is usually caused by exceptions that occurred while calling [notifyAsPackage](https://developer.android.com/reference/android/app/NotificationManager#notifyAsPackage%28java.lang.String,%20java.lang.String,%20int,%20android.app.Notification%29).
+ "proxied": 3.14, # The percentage of accepted notifications that were successfully proxied by [Google Play services](https://developers.google.com/android/guides/overview).
+ "skippedNotThrottled": 3.14, # The percentage of accepted notifications that were skipped because the messages were not throttled.
+ "skippedOptedOut": 3.14, # The percentage of accepted notifications that were skipped because the app disallowed these messages to be proxied.
+ "skippedUnconfigured": 3.14, # The percentage of accepted notifications that were skipped because configurations required for notifications to be proxied were missing.
+ "skippedUnsupported": 3.14, # The percentage of accepted notifications that were skipped because proxy notification is unsupported for the recipient.
+ },
},
"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date represented by this entry.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
diff --git a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html
index 1a1408bec14..2d4801bf3a6 100644
--- a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html
+++ b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html
@@ -110,12 +110,24 @@ Method Details
{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
"createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
"dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
"name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
"retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
"updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
}
@@ -130,12 +142,24 @@ Method Details
{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
"createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
"dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
"name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
"retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
"updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
}
@@ -175,12 +199,24 @@ Method Details
{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
"createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
"dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
"name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
"retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
"updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
}
@@ -204,12 +240,24 @@ Method Details
{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
"createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
"dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
"name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
"retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
"updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
},
],
@@ -228,12 +276,24 @@ Method Details
{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
"createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
"dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
"name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
"retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
"updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
}
@@ -249,12 +309,24 @@ Method Details
{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
"createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
"dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
"name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
"retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
"updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day.
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
+ "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
},
}
diff --git a/docs/dyn/firestore_v1.projects.databases.html b/docs/dyn/firestore_v1.projects.databases.html
index d4a1e4e0b6e..ed709c893ef 100644
--- a/docs/dyn/firestore_v1.projects.databases.html
+++ b/docs/dyn/firestore_v1.projects.databases.html
@@ -154,6 +154,7 @@ Method Details
"locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
"name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}`
"pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database.
+ "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases.
"type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
"uid": "A String", # Output only. The system-generated UUID4 for this Database.
"updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
@@ -307,6 +308,7 @@ Method Details
"locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
"name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}`
"pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database.
+ "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases.
"type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
"uid": "A String", # Output only. The system-generated UUID4 for this Database.
"updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
@@ -397,6 +399,7 @@ Method Details
"locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
"name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}`
"pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database.
+ "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases.
"type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
"uid": "A String", # Output only. The system-generated UUID4 for this Database.
"updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
@@ -436,6 +439,7 @@ Method Details
"locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
"name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}`
"pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database.
+ "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases.
"type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
"uid": "A String", # Output only. The system-generated UUID4 for this Database.
"updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
diff --git a/docs/dyn/gkehub_v1.projects.locations.memberships.bindings.html b/docs/dyn/gkehub_v1.projects.locations.memberships.bindings.html
index 132fe1ad760..bbbe845222e 100644
--- a/docs/dyn/gkehub_v1.projects.locations.memberships.bindings.html
+++ b/docs/dyn/gkehub_v1.projects.locations.memberships.bindings.html
@@ -255,6 +255,9 @@ Method Details
},
],
"nextPageToken": "A String", # A token to request the next page of resources from the `ListMembershipBindings` method. The value of an empty string means that there are no more resources to return.
+ "unreachable": [ # List of locations that could not be reached while fetching this list.
+ "A String",
+ ],
}
diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.bindings.html b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.bindings.html
index 29f2aec6bde..768e4387c9e 100644
--- a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.bindings.html
+++ b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.bindings.html
@@ -255,6 +255,9 @@ Method Details
},
],
"nextPageToken": "A String", # A token to request the next page of resources from the `ListMembershipBindings` method. The value of an empty string means that there are no more resources to return.
+ "unreachable": [ # List of locations that could not be reached while fetching this list.
+ "A String",
+ ],
}
diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.rbacrolebindings.html b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.rbacrolebindings.html
index 8c92f914f2d..530d11f0dde 100644
--- a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.rbacrolebindings.html
+++ b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.rbacrolebindings.html
@@ -311,6 +311,9 @@ Method Details
"user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
},
],
+ "unreachable": [ # List of locations that could not be reached while fetching this list.
+ "A String",
+ ],
}
diff --git a/docs/dyn/gkehub_v1beta.projects.locations.memberships.bindings.html b/docs/dyn/gkehub_v1beta.projects.locations.memberships.bindings.html
index 49f774f6f92..b631c40a50d 100644
--- a/docs/dyn/gkehub_v1beta.projects.locations.memberships.bindings.html
+++ b/docs/dyn/gkehub_v1beta.projects.locations.memberships.bindings.html
@@ -255,6 +255,9 @@ Method Details
},
],
"nextPageToken": "A String", # A token to request the next page of resources from the `ListMembershipBindings` method. The value of an empty string means that there are no more resources to return.
+ "unreachable": [ # List of locations that could not be reached while fetching this list.
+ "A String",
+ ],
}
diff --git a/docs/dyn/gkehub_v1beta.projects.locations.memberships.rbacrolebindings.html b/docs/dyn/gkehub_v1beta.projects.locations.memberships.rbacrolebindings.html
index 58631021ffd..56c0872ab3b 100644
--- a/docs/dyn/gkehub_v1beta.projects.locations.memberships.rbacrolebindings.html
+++ b/docs/dyn/gkehub_v1beta.projects.locations.memberships.rbacrolebindings.html
@@ -311,6 +311,9 @@ Method Details
"user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
},
],
+ "unreachable": [ # List of locations that could not be reached while fetching this list.
+ "A String",
+ ],
}
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
index f0dc6547125..5171430d13c 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
@@ -106,6 +106,9 @@ Instance Methods
export(name, body=None, x__xgafv=None)
Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
+
+ exportHistory(name, body=None, x__xgafv=None)
+Export resources including historical versions from the FHIR store to the specified destination. The exported resource, along with previous versions, will be exported in one or more FHIR history bundles. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
Gets the configuration of the specified FHIR store.
@@ -115,6 +118,9 @@ Instance Methods
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+ importHistory(name, body=None, x__xgafv=None)
+Import resource historical versions from Cloud Storage source to destination fhir store. The exported resource, along with previous versions, will be exported in one or more FHIR history bundles. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
import_(name, body=None, x__xgafv=None)
Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data are specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
@@ -1242,6 +1248,66 @@ Method Details
}
+
+ exportHistory(name, body=None, x__xgafv=None)
+ Export resources including historical versions from the FHIR store to the specified destination. The exported resource, along with previous versions, will be exported in one or more FHIR history bundles. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
+
+Args:
+ name: string, Required. The name of the FHIR store to export resource from, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to export the history of resources.
+ "_since": "A String", # If provided, only resources versions updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
+ "_type": "A String", # String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
+ "bigqueryDestination": { # The configuration for exporting to BigQuery. # The BigQuery output destination. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output is one BigQuery table per resource type. Unlike when setting `BigQueryDestination` for `StreamConfig`, `ExportResources` does not create BigQuery views.
+ "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`.
+ "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.
+ "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema.
+ "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
+ "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition.
+ "type": "A String", # Type of partitioning.
+ },
+ "recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5.
+ "schemaType": "A String", # Specifies the output schema type. Schema type is required.
+ },
+ "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.
+ },
+ "gcsDestination": { # The configuration for exporting to Cloud Storage. # The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one or more objects per resource type depending on the volume of the resources exported. When there is only one object per resource type, the object name is in the form of `{operation_id})_history_{resource_type}`. When there are multiple objects for a given resource type, the object names are in the form of `{operation_id}_history_{resource_type}-{index}-of-{total}`. Each object contains newline delimited JSON, and each line is a FHIR history bundle containing the history for a single resource.
+ "uriPrefix": "A String", # URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service appends one when composing the object path. The Cloud Storage bucket referenced in `uri_prefix` must exist or an error occurs.
+ },
+ "maxResourceVersions": "A String", # If provided and non-zero, places a limit on the number of resource versions that are returned for a given resource. For example, if the limit is `100` and a resource has over 100 versions, only the 100 most recent versions will be returned. Must be positive.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
get(name, x__xgafv=None)
Gets the configuration of the specified FHIR store.
@@ -1609,6 +1675,52 @@ Method Details
}
+
+ importHistory(name, body=None, x__xgafv=None)
+ Import resource historical versions from Cloud Storage source to destination fhir store. The exported resource, along with previous versions, will be exported in one or more FHIR history bundles. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
+
+Args:
+ name: string, Required. The name of the FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to import the history of resources.
+ "contentStructure": "A String", # The content structure in the source location. If not specified, the server treats the input source files as BUNDLE.
+ "gcsSource": { # Specifies the configuration for importing data from Cloud Storage. # Cloud Storage source data location and import configuration. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location. The Healthcare Service Agent Each Cloud Storage object should be a text file that contains the format specified in ContentStructure.
+ "uri": "A String", # Points to a Cloud Storage URI containing file(s) to import. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: * `*` to match 0 or more non-separator characters * `**` to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson` extensions in `my-directory/` and its sub-directories. * `?` to match 1 character Files matching the wildcard are expected to contain content only, no metadata.
+ },
+ "maxErrorCount": "A String", # The maximum number of errors before the server cancels the operation. If not specified or set to 0, defaults to 100. -1 means no maximum, the server tries to process all input. Since the server executes the operation in parallel, it might not stop the operation after exactly this number of errors occur.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
import_(name, body=None, x__xgafv=None)
Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data are specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
diff --git a/docs/dyn/iap_v1.v1.html b/docs/dyn/iap_v1.v1.html
index f1672166717..bb99c04caaa 100644
--- a/docs/dyn/iap_v1.v1.html
+++ b/docs/dyn/iap_v1.v1.html
@@ -159,32 +159,32 @@ Method Details
An object of the form:
{ # The IAP configurable settings.
- "accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
- "allowedDomainsSettings": { # Configuration for IAP allowed domains. Lets you to restrict access to an app and allow access to only the domains that you list. # Settings to configure and enable allowed domains.
- "domains": [ # List of trusted domains.
+ "accessSettings": { # Access related settings for IAP protected apps. # Optional. Top level wrapper for all access related setting in IAP
+ "allowedDomainsSettings": { # Configuration for IAP allowed domains. Lets you to restrict access to an app and allow access to only the domains that you list. # Optional. Settings to configure and enable allowed domains.
+ "domains": [ # Optional. List of trusted domains.
"A String",
],
- "enable": True or False, # Configuration for customers to opt in for the feature.
+ "enable": True or False, # Optional. Configuration for customers to opt in for the feature.
},
- "corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. # Configuration to allow cross-origin requests via IAP.
+ "corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. # Optional. Configuration to allow cross-origin requests via IAP.
"allowHttpOptions": True or False, # Configuration to allow HTTP OPTIONS calls to skip authorization. If undefined, IAP will not apply any special logic to OPTIONS requests.
},
- "gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # GCIP claims and endpoint configurations for 3p identity providers.
+ "gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # Optional. GCIP claims and endpoint configurations for 3p identity providers.
"loginPageUri": "A String", # Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.
- "tenantIds": [ # GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _ to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.
+ "tenantIds": [ # Optional. GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _ to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.
"A String",
],
},
"identitySources": [ # Optional. Identity sources that IAP can use to authenticate the end user. Only one identity source can be configured.
"A String",
],
- "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Settings to configure IAP's OAuth behavior.
+ "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Optional. Settings to configure IAP's OAuth behavior.
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.
- "programmaticClients": [ # List of client ids allowed to use IAP programmatically.
+ "programmaticClients": [ # Optional. List of client ids allowed to use IAP programmatically.
"A String",
],
},
- "policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto. # Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY.
+ "policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto. # Optional. Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY.
"iamPermission": "A String", # Permission to check in IAM.
"iamServiceName": "A String", # The DNS name of the service (e.g. "resourcemanager.googleapis.com"). This should be the domain name part of the full resource names (see https://aip.dev/122#full-resource-names), which is usually the same as IamServiceSpec.service of the service where the resource type is defined.
"policyName": { # An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names. # Policy name to be checked
@@ -204,10 +204,10 @@ Method Details
"type": "A String", # The public resource type name of the resource. It is configured using the official_name of the ResourceType as defined in service configurations under //configs/cloud/resourcetypes. For example, the official_name for GCP projects is set as 'cloudresourcemanager.googleapis.com/Project' according to //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml This field is **required** for services integrated with resource-attribute-based IAM conditions and/or CustomOrgPolicy. This field requires special handling for parents-only permissions such as `create` and `list`. See the document linked below for further details. See go/iam-conditions-sig-g3#populate-resource-attributes for specific details on populating this field.
},
},
- "reauthSettings": { # Configuration for IAP reauthentication policies. # Settings to configure reauthentication policies in IAP.
- "maxAge": "A String", # Reauth session lifetime, how long before a user has to reauthenticate again.
+ "reauthSettings": { # Configuration for IAP reauthentication policies. # Optional. Settings to configure reauthentication policies in IAP.
+ "maxAge": "A String", # Optional. Reauth session lifetime, how long before a user has to reauthenticate again.
"method": "A String", # Reauth method requested.
- "policyType": "A String", # How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.
+ "policyType": "A String", # Optional. How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.
},
"workforceIdentitySettings": { # WorkforceIdentitySettings allows customers to configure workforce pools and OAuth 2.0 settings to gate their applications using a third-party IdP with access control. # Optional. Settings to configure the workforce identity federation, including workforce pools and OAuth 2.0 settings.
"oauth2": { # The OAuth 2.0 Settings # OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.
@@ -220,21 +220,21 @@ Method Details
],
},
},
- "applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
- "accessDeniedPageSettings": { # Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead. # Customization for Access Denied page.
+ "applicationSettings": { # Wrapper over application specific settings for IAP. # Optional. Top level wrapper for all application related settings in IAP
+ "accessDeniedPageSettings": { # Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead. # Optional. Customization for Access Denied page.
"accessDeniedPageUri": "A String", # The URI to be redirected to when access is denied.
"generateTroubleshootingUri": True or False, # Whether to generate a troubleshooting URL on access denied events to this application.
"remediationTokenGenerationEnabled": True or False, # Whether to generate remediation token on access denied events to this application.
},
- "attributePropagationSettings": { # Configuration for propagating attributes to applications protected by IAP. # Settings to configure attribute propagation.
- "enable": True or False, # Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.
- "expression": "A String", # Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from `attributes`: `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name field to the given `` for propagation in selected output credentials. - strict `.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER` output credential, such as request headers. - append `.append()` OR `.append()`: Appends the provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
- "outputCredentials": [ # Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
+ "attributePropagationSettings": { # Configuration for propagating attributes to applications protected by IAP. # Optional. Settings to configure attribute propagation.
+ "enable": True or False, # Optional. Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.
+ "expression": "A String", # Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from `attributes`: `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name field to the given `` for propagation in selected output credentials. - strict `.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER` output credential, such as request headers. - append `.append()` OR `.append()`: Appends the provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
+ "outputCredentials": [ # Optional. Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
"A String",
],
},
"cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not validated by the API, but will be ignored at runtime if invalid.
- "csmSettings": { # Configuration for RCToken generated for service mesh workloads protected by IAP. RCToken are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for service mesh deployments, and can be scoped to a single mesh by configuring the audience field accordingly. # Settings to configure IAP's behavior for a service mesh.
+ "csmSettings": { # Configuration for RCToken generated for service mesh workloads protected by IAP. RCToken are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for service mesh deployments, and can be scoped to a single mesh by configuring the audience field accordingly. # Optional. Settings to configure IAP's behavior for a service mesh.
"rctokenAud": "A String", # Audience claim set in the generated RCToken. This value is not validated by IAP.
},
},
@@ -340,32 +340,32 @@ Method Details
The object takes the form of:
{ # The IAP configurable settings.
- "accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
- "allowedDomainsSettings": { # Configuration for IAP allowed domains. Lets you to restrict access to an app and allow access to only the domains that you list. # Settings to configure and enable allowed domains.
- "domains": [ # List of trusted domains.
+ "accessSettings": { # Access related settings for IAP protected apps. # Optional. Top level wrapper for all access related setting in IAP
+ "allowedDomainsSettings": { # Configuration for IAP allowed domains. Lets you to restrict access to an app and allow access to only the domains that you list. # Optional. Settings to configure and enable allowed domains.
+ "domains": [ # Optional. List of trusted domains.
"A String",
],
- "enable": True or False, # Configuration for customers to opt in for the feature.
+ "enable": True or False, # Optional. Configuration for customers to opt in for the feature.
},
- "corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. # Configuration to allow cross-origin requests via IAP.
+ "corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. # Optional. Configuration to allow cross-origin requests via IAP.
"allowHttpOptions": True or False, # Configuration to allow HTTP OPTIONS calls to skip authorization. If undefined, IAP will not apply any special logic to OPTIONS requests.
},
- "gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # GCIP claims and endpoint configurations for 3p identity providers.
+ "gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # Optional. GCIP claims and endpoint configurations for 3p identity providers.
"loginPageUri": "A String", # Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.
- "tenantIds": [ # GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _ to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.
+ "tenantIds": [ # Optional. GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _ to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.
"A String",
],
},
"identitySources": [ # Optional. Identity sources that IAP can use to authenticate the end user. Only one identity source can be configured.
"A String",
],
- "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Settings to configure IAP's OAuth behavior.
+ "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Optional. Settings to configure IAP's OAuth behavior.
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.
- "programmaticClients": [ # List of client ids allowed to use IAP programmatically.
+ "programmaticClients": [ # Optional. List of client ids allowed to use IAP programmatically.
"A String",
],
},
- "policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto. # Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY.
+ "policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto. # Optional. Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY.
"iamPermission": "A String", # Permission to check in IAM.
"iamServiceName": "A String", # The DNS name of the service (e.g. "resourcemanager.googleapis.com"). This should be the domain name part of the full resource names (see https://aip.dev/122#full-resource-names), which is usually the same as IamServiceSpec.service of the service where the resource type is defined.
"policyName": { # An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names. # Policy name to be checked
@@ -385,10 +385,10 @@ Method Details
"type": "A String", # The public resource type name of the resource. It is configured using the official_name of the ResourceType as defined in service configurations under //configs/cloud/resourcetypes. For example, the official_name for GCP projects is set as 'cloudresourcemanager.googleapis.com/Project' according to //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml This field is **required** for services integrated with resource-attribute-based IAM conditions and/or CustomOrgPolicy. This field requires special handling for parents-only permissions such as `create` and `list`. See the document linked below for further details. See go/iam-conditions-sig-g3#populate-resource-attributes for specific details on populating this field.
},
},
- "reauthSettings": { # Configuration for IAP reauthentication policies. # Settings to configure reauthentication policies in IAP.
- "maxAge": "A String", # Reauth session lifetime, how long before a user has to reauthenticate again.
+ "reauthSettings": { # Configuration for IAP reauthentication policies. # Optional. Settings to configure reauthentication policies in IAP.
+ "maxAge": "A String", # Optional. Reauth session lifetime, how long before a user has to reauthenticate again.
"method": "A String", # Reauth method requested.
- "policyType": "A String", # How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.
+ "policyType": "A String", # Optional. How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.
},
"workforceIdentitySettings": { # WorkforceIdentitySettings allows customers to configure workforce pools and OAuth 2.0 settings to gate their applications using a third-party IdP with access control. # Optional. Settings to configure the workforce identity federation, including workforce pools and OAuth 2.0 settings.
"oauth2": { # The OAuth 2.0 Settings # OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.
@@ -401,21 +401,21 @@ Method Details
],
},
},
- "applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
- "accessDeniedPageSettings": { # Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead. # Customization for Access Denied page.
+ "applicationSettings": { # Wrapper over application specific settings for IAP. # Optional. Top level wrapper for all application related settings in IAP
+ "accessDeniedPageSettings": { # Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead. # Optional. Customization for Access Denied page.
"accessDeniedPageUri": "A String", # The URI to be redirected to when access is denied.
"generateTroubleshootingUri": True or False, # Whether to generate a troubleshooting URL on access denied events to this application.
"remediationTokenGenerationEnabled": True or False, # Whether to generate remediation token on access denied events to this application.
},
- "attributePropagationSettings": { # Configuration for propagating attributes to applications protected by IAP. # Settings to configure attribute propagation.
- "enable": True or False, # Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.
- "expression": "A String", # Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from `attributes`: `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name field to the given `` for propagation in selected output credentials. - strict `.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER` output credential, such as request headers. - append `.append()` OR `.append()`: Appends the provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
- "outputCredentials": [ # Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
+ "attributePropagationSettings": { # Configuration for propagating attributes to applications protected by IAP. # Optional. Settings to configure attribute propagation.
+ "enable": True or False, # Optional. Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.
+ "expression": "A String", # Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from `attributes`: `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name field to the given `` for propagation in selected output credentials. - strict `.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER` output credential, such as request headers. - append `.append()` OR `.append()`: Appends the provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
+ "outputCredentials": [ # Optional. Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
"A String",
],
},
"cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not validated by the API, but will be ignored at runtime if invalid.
- "csmSettings": { # Configuration for RCToken generated for service mesh workloads protected by IAP. RCToken are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for service mesh deployments, and can be scoped to a single mesh by configuring the audience field accordingly. # Settings to configure IAP's behavior for a service mesh.
+ "csmSettings": { # Configuration for RCToken generated for service mesh workloads protected by IAP. RCToken are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for service mesh deployments, and can be scoped to a single mesh by configuring the audience field accordingly. # Optional. Settings to configure IAP's behavior for a service mesh.
"rctokenAud": "A String", # Audience claim set in the generated RCToken. This value is not validated by IAP.
},
},
@@ -432,32 +432,32 @@ Method Details
An object of the form:
{ # The IAP configurable settings.
- "accessSettings": { # Access related settings for IAP protected apps. # Top level wrapper for all access related setting in IAP
- "allowedDomainsSettings": { # Configuration for IAP allowed domains. Lets you to restrict access to an app and allow access to only the domains that you list. # Settings to configure and enable allowed domains.
- "domains": [ # List of trusted domains.
+ "accessSettings": { # Access related settings for IAP protected apps. # Optional. Top level wrapper for all access related setting in IAP
+ "allowedDomainsSettings": { # Configuration for IAP allowed domains. Lets you to restrict access to an app and allow access to only the domains that you list. # Optional. Settings to configure and enable allowed domains.
+ "domains": [ # Optional. List of trusted domains.
"A String",
],
- "enable": True or False, # Configuration for customers to opt in for the feature.
+ "enable": True or False, # Optional. Configuration for customers to opt in for the feature.
},
- "corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. # Configuration to allow cross-origin requests via IAP.
+ "corsSettings": { # Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. # Optional. Configuration to allow cross-origin requests via IAP.
"allowHttpOptions": True or False, # Configuration to allow HTTP OPTIONS calls to skip authorization. If undefined, IAP will not apply any special logic to OPTIONS requests.
},
- "gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # GCIP claims and endpoint configurations for 3p identity providers.
+ "gcipSettings": { # Allows customers to configure tenant_id for GCIP instance per-app. # Optional. GCIP claims and endpoint configurations for 3p identity providers.
"loginPageUri": "A String", # Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.
- "tenantIds": [ # GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _ to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.
+ "tenantIds": [ # Optional. GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _ to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements.
"A String",
],
},
"identitySources": [ # Optional. Identity sources that IAP can use to authenticate the end user. Only one identity source can be configured.
"A String",
],
- "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Settings to configure IAP's OAuth behavior.
+ "oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Optional. Settings to configure IAP's OAuth behavior.
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.
- "programmaticClients": [ # List of client ids allowed to use IAP programmatically.
+ "programmaticClients": [ # Optional. List of client ids allowed to use IAP programmatically.
"A String",
],
},
- "policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto. # Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY.
+ "policyDelegationSettings": { # PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto. # Optional. Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY.
"iamPermission": "A String", # Permission to check in IAM.
"iamServiceName": "A String", # The DNS name of the service (e.g. "resourcemanager.googleapis.com"). This should be the domain name part of the full resource names (see https://aip.dev/122#full-resource-names), which is usually the same as IamServiceSpec.service of the service where the resource type is defined.
"policyName": { # An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names. # Policy name to be checked
@@ -477,10 +477,10 @@ Method Details
"type": "A String", # The public resource type name of the resource. It is configured using the official_name of the ResourceType as defined in service configurations under //configs/cloud/resourcetypes. For example, the official_name for GCP projects is set as 'cloudresourcemanager.googleapis.com/Project' according to //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml This field is **required** for services integrated with resource-attribute-based IAM conditions and/or CustomOrgPolicy. This field requires special handling for parents-only permissions such as `create` and `list`. See the document linked below for further details. See go/iam-conditions-sig-g3#populate-resource-attributes for specific details on populating this field.
},
},
- "reauthSettings": { # Configuration for IAP reauthentication policies. # Settings to configure reauthentication policies in IAP.
- "maxAge": "A String", # Reauth session lifetime, how long before a user has to reauthenticate again.
+ "reauthSettings": { # Configuration for IAP reauthentication policies. # Optional. Settings to configure reauthentication policies in IAP.
+ "maxAge": "A String", # Optional. Reauth session lifetime, how long before a user has to reauthenticate again.
"method": "A String", # Reauth method requested.
- "policyType": "A String", # How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.
+ "policyType": "A String", # Optional. How IAP determines the effective policy in cases of hierarchical policies. Policies are merged from higher in the hierarchy to lower in the hierarchy.
},
"workforceIdentitySettings": { # WorkforceIdentitySettings allows customers to configure workforce pools and OAuth 2.0 settings to gate their applications using a third-party IdP with access control. # Optional. Settings to configure the workforce identity federation, including workforce pools and OAuth 2.0 settings.
"oauth2": { # The OAuth 2.0 Settings # OAuth 2.0 settings for IAP to perform OIDC flow with workforce identity federation services.
@@ -493,21 +493,21 @@ Method Details
],
},
},
- "applicationSettings": { # Wrapper over application specific settings for IAP. # Top level wrapper for all application related settings in IAP
- "accessDeniedPageSettings": { # Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead. # Customization for Access Denied page.
+ "applicationSettings": { # Wrapper over application specific settings for IAP. # Optional. Top level wrapper for all application related settings in IAP
+ "accessDeniedPageSettings": { # Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead. # Optional. Customization for Access Denied page.
"accessDeniedPageUri": "A String", # The URI to be redirected to when access is denied.
"generateTroubleshootingUri": True or False, # Whether to generate a troubleshooting URL on access denied events to this application.
"remediationTokenGenerationEnabled": True or False, # Whether to generate remediation token on access denied events to this application.
},
- "attributePropagationSettings": { # Configuration for propagating attributes to applications protected by IAP. # Settings to configure attribute propagation.
- "enable": True or False, # Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.
- "expression": "A String", # Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from `attributes`: `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name field to the given `` for propagation in selected output credentials. - strict `.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER` output credential, such as request headers. - append `.append()` OR `.append()`: Appends the provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
- "outputCredentials": [ # Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
+ "attributePropagationSettings": { # Configuration for propagating attributes to applications protected by IAP. # Optional. Settings to configure attribute propagation.
+ "enable": True or False, # Optional. Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.
+ "expression": "A String", # Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from `attributes`: `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name field to the given `` for propagation in selected output credentials. - strict `.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER` output credential, such as request headers. - append `.append()` OR `.append()`: Appends the provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
+ "outputCredentials": [ # Optional. Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
"A String",
],
},
"cookieDomain": "A String", # The Domain value to set for cookies generated by IAP. This value is not validated by the API, but will be ignored at runtime if invalid.
- "csmSettings": { # Configuration for RCToken generated for service mesh workloads protected by IAP. RCToken are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for service mesh deployments, and can be scoped to a single mesh by configuring the audience field accordingly. # Settings to configure IAP's behavior for a service mesh.
+ "csmSettings": { # Configuration for RCToken generated for service mesh workloads protected by IAP. RCToken are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for service mesh deployments, and can be scoped to a single mesh by configuring the audience field accordingly. # Optional. Settings to configure IAP's behavior for a service mesh.
"rctokenAud": "A String", # Audience claim set in the generated RCToken. This value is not validated by IAP.
},
},
@@ -530,7 +530,7 @@ Method Details
Returns:
An object of the form:
- { # API requires a return message, but currently all response strings will fit in the status and public message. In the future, this response can hold AST validation info.
+ { # IAP Expression Linter endpoint returns empty response body.
}
diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.html b/docs/dyn/integrations_v1.projects.locations.integrations.html
index ec87dc2c1be..5844e033d1b 100644
--- a/docs/dyn/integrations_v1.projects.locations.integrations.html
+++ b/docs/dyn/integrations_v1.projects.locations.integrations.html
@@ -933,6 +933,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -989,6 +990,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -1040,6 +1042,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -1204,6 +1207,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html
index 0b18fe1986f..45c097b0ad3 100644
--- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html
+++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html
@@ -405,6 +405,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -461,6 +462,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -512,6 +514,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -676,6 +679,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -1416,6 +1420,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -1472,6 +1477,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -1523,6 +1529,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -1687,6 +1694,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -2496,6 +2504,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -2552,6 +2561,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -2603,6 +2613,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -2767,6 +2778,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -3516,6 +3528,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -3572,6 +3585,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -3623,6 +3637,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -3787,6 +3802,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -4539,6 +4555,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -4595,6 +4612,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -4646,6 +4664,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -4810,6 +4829,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -5568,6 +5588,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -5624,6 +5645,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -5675,6 +5697,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -5839,6 +5862,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -6578,6 +6602,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -6634,6 +6659,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -6685,6 +6711,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -6849,6 +6876,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -7654,6 +7682,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -7710,6 +7739,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -7761,6 +7791,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -7925,6 +7956,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.html
index 9f9d25e8db7..f2561f2ba68 100644
--- a/docs/dyn/integrations_v1.projects.locations.products.integrations.html
+++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.html
@@ -888,6 +888,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -944,6 +945,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -995,6 +997,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -1159,6 +1162,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html
index af10701818a..28c7fc206ff 100644
--- a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html
+++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html
@@ -405,6 +405,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -461,6 +462,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -512,6 +514,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -676,6 +679,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -1416,6 +1420,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -1472,6 +1477,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -1523,6 +1529,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -1687,6 +1694,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -2485,6 +2493,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -2541,6 +2550,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -2592,6 +2602,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -2756,6 +2767,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -3508,6 +3520,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -3564,6 +3577,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -3615,6 +3629,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -3779,6 +3794,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -4537,6 +4553,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -4593,6 +4610,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -4644,6 +4662,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -4808,6 +4827,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -5547,6 +5567,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -5603,6 +5624,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -5654,6 +5676,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -5818,6 +5841,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -6597,6 +6621,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -6653,6 +6678,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -6704,6 +6730,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -6868,6 +6895,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
@@ -7647,6 +7675,7 @@ Method Details
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -7703,6 +7732,7 @@ Method Details
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
@@ -7754,6 +7784,7 @@ Method Details
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
@@ -7918,6 +7949,7 @@ Method Details
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
diff --git a/docs/dyn/metastore_v1.projects.locations.services.backups.html b/docs/dyn/metastore_v1.projects.locations.services.backups.html
index b9904e1cee2..b68a37dadcc 100644
--- a/docs/dyn/metastore_v1.projects.locations.services.backups.html
+++ b/docs/dyn/metastore_v1.projects.locations.services.backups.html
@@ -125,6 +125,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -329,6 +330,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -521,6 +523,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
diff --git a/docs/dyn/metastore_v1.projects.locations.services.databases.html b/docs/dyn/metastore_v1.projects.locations.services.databases.html
new file mode 100644
index 00000000000..c99d2f08199
--- /dev/null
+++ b/docs/dyn/metastore_v1.projects.locations.services.databases.html
@@ -0,0 +1,230 @@
+
+
+
+Dataproc Metastore API . projects . locations . services . databases
+Instance Methods
+
+ tables()
+
+Returns the tables Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+ Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/metastore_v1.projects.locations.services.databases.tables.html b/docs/dyn/metastore_v1.projects.locations.services.databases.tables.html
new file mode 100644
index 00000000000..5e47e46de32
--- /dev/null
+++ b/docs/dyn/metastore_v1.projects.locations.services.databases.tables.html
@@ -0,0 +1,225 @@
+
+
+
+Dataproc Metastore API . projects . locations . services . databases . tables
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+ Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/metastore_v1.projects.locations.services.html b/docs/dyn/metastore_v1.projects.locations.services.html
index 6d756a3021d..1b9dc9bfdff 100644
--- a/docs/dyn/metastore_v1.projects.locations.services.html
+++ b/docs/dyn/metastore_v1.projects.locations.services.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the backups Resource.
+
+ databases()
+
+Returns the databases Resource.
+
@@ -240,6 +245,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -478,6 +484,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -661,6 +668,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -847,6 +855,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html
index d82699622aa..ef9db821e35 100644
--- a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html
+++ b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html
@@ -128,6 +128,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -349,6 +350,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -558,6 +560,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.html b/docs/dyn/metastore_v1alpha.projects.locations.services.html
index a5148f04ba1..512cb874a8a 100644
--- a/docs/dyn/metastore_v1alpha.projects.locations.services.html
+++ b/docs/dyn/metastore_v1alpha.projects.locations.services.html
@@ -344,6 +344,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -599,6 +600,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -799,6 +801,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -1002,6 +1005,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html
index 9579afc5820..4777840b24a 100644
--- a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html
+++ b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html
@@ -128,6 +128,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -349,6 +350,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -558,6 +560,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.html b/docs/dyn/metastore_v1beta.projects.locations.services.html
index 3699267db6d..7f46f24a75e 100644
--- a/docs/dyn/metastore_v1beta.projects.locations.services.html
+++ b/docs/dyn/metastore_v1beta.projects.locations.services.html
@@ -344,6 +344,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -599,6 +600,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -799,6 +801,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
@@ -1002,6 +1005,7 @@ Method Details
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
+ "deletionProtection": True or False, # Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
index b5a700187ca..7ca6d0ae875 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
@@ -293,17 +293,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
@@ -869,17 +864,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
@@ -1477,17 +1467,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
@@ -2066,17 +2051,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
@@ -2657,17 +2637,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
@@ -3228,17 +3203,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
@@ -3798,17 +3768,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
index 6c22ddb926f..479a0d388f7 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
@@ -192,17 +192,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
@@ -637,17 +632,12 @@ Method Details
],
},
"topology": { # Details of database deployment's topology. # Details of the database deployment topology.
- "coreCount": 42, # Optional. Number of total cores.
- "coreLimit": 42, # Optional. Number of total cores limited by db deployment.
+ "coreCount": 42, # Optional. Number of total logical cores.
+ "coreLimit": 42, # Optional. Number of total logical cores limited by db deployment.
"diskAllocatedBytes": "A String", # Optional. Disk allocated in bytes.
"diskUsedBytes": "A String", # Optional. Disk used in bytes.
"instances": [ # Optional. List of database instances.
{ # Details of a database instance.
- "hosts": [ # Optional. The instance's hosts.
- { # Details of a host of a database instance.
- "hostName": "A String", # Optional. The host name of the host.
- },
- ],
"instanceName": "A String", # The instance's name.
"role": "A String", # The instance role in the database engine.
},
diff --git a/docs/dyn/monitoring_v3.uptimeCheckIps.html b/docs/dyn/monitoring_v3.uptimeCheckIps.html
index fd28094e48d..41ae3babc34 100644
--- a/docs/dyn/monitoring_v3.uptimeCheckIps.html
+++ b/docs/dyn/monitoring_v3.uptimeCheckIps.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
list(pageSize=None, pageToken=None, x__xgafv=None)
-Returns the list of IP addresses that checkers run from
+Returns the list of IP addresses that checkers run from.
Retrieves the next page of results.
@@ -91,7 +91,7 @@ Method Details
list(pageSize=None, pageToken=None, x__xgafv=None)
- Returns the list of IP addresses that checkers run from
+ Returns the list of IP addresses that checkers run from.
Args:
pageSize: integer, The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented
diff --git a/docs/dyn/orgpolicy_v2.folders.constraints.html b/docs/dyn/orgpolicy_v2.folders.constraints.html
index 3de8e8d9677..d8979b8b995 100644
--- a/docs/dyn/orgpolicy_v2.folders.constraints.html
+++ b/docs/dyn/orgpolicy_v2.folders.constraints.html
@@ -113,16 +113,6 @@ Method Details
"constraintDefault": "A String", # The evaluation behavior of this constraint in the absence of a policy.
"description": "A String", # Detailed description of what this constraint controls as well as how and where it is enforced. Mutable.
"displayName": "A String", # The human readable name. Mutable.
- "googleManagedConstraint": { # A Google managed constraint. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint # Defines this constraint as being a GoogleManagedConstraint.
- "actionType": "A String", # Allow or deny type.
- "condition": "A String", # Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.
- "methodTypes": [ # All the operations being applied for this constraint.
- "A String",
- ],
- "resourceTypes": [ # The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.
- "A String",
- ],
- },
"listConstraint": { # A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy. # Defines this constraint as being a ListConstraint.
"supportsIn": True or False, # Indicates whether values grouped into categories can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"in:Python"` would match any value in the 'Python' group.
"supportsUnder": True or False, # Indicates whether subtrees of the Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder.
diff --git a/docs/dyn/orgpolicy_v2.organizations.constraints.html b/docs/dyn/orgpolicy_v2.organizations.constraints.html
index 097ef236c5c..11d8b468531 100644
--- a/docs/dyn/orgpolicy_v2.organizations.constraints.html
+++ b/docs/dyn/orgpolicy_v2.organizations.constraints.html
@@ -113,16 +113,6 @@ Method Details
"constraintDefault": "A String", # The evaluation behavior of this constraint in the absence of a policy.
"description": "A String", # Detailed description of what this constraint controls as well as how and where it is enforced. Mutable.
"displayName": "A String", # The human readable name. Mutable.
- "googleManagedConstraint": { # A Google managed constraint. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint # Defines this constraint as being a GoogleManagedConstraint.
- "actionType": "A String", # Allow or deny type.
- "condition": "A String", # Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.
- "methodTypes": [ # All the operations being applied for this constraint.
- "A String",
- ],
- "resourceTypes": [ # The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.
- "A String",
- ],
- },
"listConstraint": { # A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy. # Defines this constraint as being a ListConstraint.
"supportsIn": True or False, # Indicates whether values grouped into categories can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"in:Python"` would match any value in the 'Python' group.
"supportsUnder": True or False, # Indicates whether subtrees of the Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder.
diff --git a/docs/dyn/orgpolicy_v2.projects.constraints.html b/docs/dyn/orgpolicy_v2.projects.constraints.html
index 7158c8dd84d..fc9b70a64da 100644
--- a/docs/dyn/orgpolicy_v2.projects.constraints.html
+++ b/docs/dyn/orgpolicy_v2.projects.constraints.html
@@ -113,16 +113,6 @@ Method Details
"constraintDefault": "A String", # The evaluation behavior of this constraint in the absence of a policy.
"description": "A String", # Detailed description of what this constraint controls as well as how and where it is enforced. Mutable.
"displayName": "A String", # The human readable name. Mutable.
- "googleManagedConstraint": { # A Google managed constraint. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint # Defines this constraint as being a GoogleManagedConstraint.
- "actionType": "A String", # Allow or deny type.
- "condition": "A String", # Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.
- "methodTypes": [ # All the operations being applied for this constraint.
- "A String",
- ],
- "resourceTypes": [ # The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.
- "A String",
- ],
- },
"listConstraint": { # A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy. # Defines this constraint as being a ListConstraint.
"supportsIn": True or False, # Indicates whether values grouped into categories can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"in:Python"` would match any value in the 'Python' group.
"supportsUnder": True or False, # Indicates whether subtrees of the Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder.
diff --git a/docs/dyn/osconfig_v1.projects.locations.osPolicyAssignments.html b/docs/dyn/osconfig_v1.projects.locations.osPolicyAssignments.html
index df72b37cbee..fe6e9ea6dfd 100644
--- a/docs/dyn/osconfig_v1.projects.locations.osPolicyAssignments.html
+++ b/docs/dyn/osconfig_v1.projects.locations.osPolicyAssignments.html
@@ -83,10 +83,10 @@ Instance Methods
close()
Close httplib2 connections.
- create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)
+ create(parent, body=None, osPolicyAssignmentId=None, requestId=None, x__xgafv=None)
Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
+ delete(name, requestId=None, x__xgafv=None)
Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
@@ -104,7 +104,7 @@ Instance Methods
list_next()
Retrieves the next page of results.
- patch(name, body=None, updateMask=None, x__xgafv=None)
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, x__xgafv=None)
Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
Method Details
@@ -113,7 +113,7 @@ Method Details
- create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)
+ create(parent, body=None, osPolicyAssignmentId=None, requestId=None, x__xgafv=None)
Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
Args:
@@ -347,6 +347,7 @@ Method Details
}
osPolicyAssignmentId: string, Required. The logical name of the OS policy assignment in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
+ requestId: string, Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -377,11 +378,12 @@ Method Details
- delete(name, x__xgafv=None)
+ delete(name, requestId=None, x__xgafv=None)
Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
Args:
name: string, Required. The name of the OS policy assignment to be deleted (required)
+ requestId: string, Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1174,7 +1176,7 @@ Method Details
- patch(name, body=None, updateMask=None, x__xgafv=None)
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, x__xgafv=None)
Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
Args:
@@ -1407,6 +1409,8 @@ Method Details
"uid": "A String", # Output only. Server generated unique id for the OS policy assignment resource.
}
+ allowMissing: boolean, Optional. If set to true, and the OS policy assignment is not found, a new OS policy assignment will be created. In this situation, `update_mask` is ignored.
+ requestId: string, Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.
updateMask: string, Optional. Field mask that controls which fields of the assignment should be updated.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html b/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html
index 15fb7449782..8b174d8f860 100644
--- a/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html
+++ b/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html
@@ -83,10 +83,10 @@ Instance Methods
close()
Close httplib2 connections.
- create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)
+ create(parent, body=None, osPolicyAssignmentId=None, requestId=None, x__xgafv=None)
Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+ delete(name, requestId=None, x__xgafv=None)
Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
@@ -104,7 +104,7 @@ Instance Methods
list_next()
Retrieves the next page of results.
- patch(name, body=None, updateMask=None, x__xgafv=None)
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, x__xgafv=None)
Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Method Details
@@ -113,7 +113,7 @@ Method Details
- create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)
+ create(parent, body=None, osPolicyAssignmentId=None, requestId=None, x__xgafv=None)
Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Args:
@@ -354,6 +354,7 @@ Method Details
}
osPolicyAssignmentId: string, Required. The logical name of the OS policy assignment in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
+ requestId: string, Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -384,11 +385,12 @@ Method Details
- delete(name, x__xgafv=None)
+ delete(name, requestId=None, x__xgafv=None)
Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Args:
name: string, Required. The name of the OS policy assignment to be deleted (required)
+ requestId: string, Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1202,7 +1204,7 @@ Method Details
- patch(name, body=None, updateMask=None, x__xgafv=None)
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, x__xgafv=None)
Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
Args:
@@ -1442,6 +1444,8 @@ Method Details
"uid": "A String", # Output only. Server generated unique id for the OS policy assignment resource.
}
+ allowMissing: boolean, Optional. If set to true, and the OS policy assignment is not found, a new OS policy assignment will be created. In this situation, `update_mask` is ignored.
+ requestId: string, Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.
updateMask: string, Optional. Field mask that controls which fields of the assignment should be updated.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html
index 63f68222814..b274669036e 100644
--- a/docs/dyn/places_v1.places.html
+++ b/docs/dyn/places_v1.places.html
@@ -108,7 +108,7 @@ Method Details
{ # Request proto for AutocompletePlaces.
"includeQueryPredictions": True or False, # Optional. If true, the response will include both Place and query predictions. Otherwise the response will only return Place predictions.
- "includedPrimaryTypes": [ # Optional. Included primary Place type (for example, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.
+ "includedPrimaryTypes": [ # Optional. Included primary Place type (for example, "restaurant" or "gas_station") in Place Types (https://developers.google.com/maps/documentation/places/web-service/place-types), or only `(regions)`, or only `(cities)`. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.
"A String",
],
"includedRegionCodes": [ # Optional. Only include results in the specified regions, specified as up to 15 CLDR two-character region codes. An empty set will not restrict the results. If both `location_restriction` and `included_region_codes` are set, the results will be located in the area of intersection.
diff --git a/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html b/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html
index fece5013fe7..1b0fa43c01c 100644
--- a/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html
+++ b/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html
@@ -77,12 +77,21 @@ Instance Methods
Close httplib2 connections.
+
+ create(parent, body=None, muteConfigId=None, x__xgafv=None)
+Creates a mute config.
Deletes an existing mute config.
Gets a mute config.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+Lists mute configs.
+
+Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a mute config.
@@ -92,6 +101,45 @@ Method Details
Close httplib2 connections.
+
+ create(parent, body=None, muteConfigId=None, x__xgafv=None)
+ Creates a mute config.
+
+Args:
+ parent: string, Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+}
+
+ muteConfigId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+}
+
+
delete(name, x__xgafv=None)
Deletes an existing mute config.
@@ -135,6 +183,52 @@ Method Details
}
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists mute configs.
+
+Args:
+ parent: string, Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". (required)
+ pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for listing mute configs.
+ "muteConfigs": [ # The mute configs from the specified parent.
+ { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a mute config.
diff --git a/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html b/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html
index a70ce5d018d..580f4747abd 100644
--- a/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html
+++ b/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html
@@ -77,12 +77,21 @@ Instance Methods
Close httplib2 connections.
+
+ create(parent, body=None, muteConfigId=None, x__xgafv=None)
+Creates a mute config.
Deletes an existing mute config.
Gets a mute config.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+Lists mute configs.
+
+Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a mute config.
@@ -92,6 +101,45 @@ Method Details
Close httplib2 connections.
+
+ create(parent, body=None, muteConfigId=None, x__xgafv=None)
+ Creates a mute config.
+
+Args:
+ parent: string, Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+}
+
+ muteConfigId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+}
+
+
delete(name, x__xgafv=None)
Deletes an existing mute config.
@@ -135,6 +183,52 @@ Method Details
}
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists mute configs.
+
+Args:
+ parent: string, Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". (required)
+ pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for listing mute configs.
+ "muteConfigs": [ # The mute configs from the specified parent.
+ { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a mute config.
diff --git a/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html b/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html
index 30cd455c3b1..63f6fca7d33 100644
--- a/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html
+++ b/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html
@@ -109,25 +109,25 @@ Method Details
"requests": [ # Required. The resource value configs to be created.
{ # Request message to create single resource value config
"parent": "A String", # Required. Resource name of the new ResourceValueConfig's parent.
- "resourceValueConfig": { # A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. # Required. The resource value config being created.
+ "resourceValueConfig": { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. # Required. The resource value config being created.
"cloudProvider": "A String", # Cloud provider this configuration applies to
- "createTime": "A String", # Output only. Timestamp this resource value config was created.
- "description": "A String", # Description of the resource value config.
- "name": "A String", # Name for the resource value config
- "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+ "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
+ "description": "A String", # Description of the resource value configuration.
+ "name": "A String", # Name for the resource value configuration
+ "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
"a_key": "A String",
},
- "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
+ "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
"resourceValue": "A String", # Required. Resource value level this expression represents
- "scope": "A String", # Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources.
+ "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources.
"sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
"highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
"mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
},
- "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+ "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
"A String",
],
- "updateTime": "A String", # Output only. Timestamp this resource value config was last updated.
+ "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
},
},
],
@@ -143,25 +143,25 @@ Method Details
{ # Response message for BatchCreateResourceValueConfigs
"resourceValueConfigs": [ # The resource value configs created
- { # A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
+ { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
"cloudProvider": "A String", # Cloud provider this configuration applies to
- "createTime": "A String", # Output only. Timestamp this resource value config was created.
- "description": "A String", # Description of the resource value config.
- "name": "A String", # Name for the resource value config
- "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+ "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
+ "description": "A String", # Description of the resource value configuration.
+ "name": "A String", # Name for the resource value configuration
+ "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
"a_key": "A String",
},
- "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
+ "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
"resourceValue": "A String", # Required. Resource value level this expression represents
- "scope": "A String", # Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources.
+ "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources.
"sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
"highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
"mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
},
- "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+ "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
"A String",
],
- "updateTime": "A String", # Output only. Timestamp this resource value config was last updated.
+ "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
},
],
}
@@ -204,25 +204,25 @@ Method Details
Returns:
An object of the form:
- { # A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
+ { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
"cloudProvider": "A String", # Cloud provider this configuration applies to
- "createTime": "A String", # Output only. Timestamp this resource value config was created.
- "description": "A String", # Description of the resource value config.
- "name": "A String", # Name for the resource value config
- "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+ "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
+ "description": "A String", # Description of the resource value configuration.
+ "name": "A String", # Name for the resource value configuration
+ "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
"a_key": "A String",
},
- "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
+ "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
"resourceValue": "A String", # Required. Resource value level this expression represents
- "scope": "A String", # Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources.
+ "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources.
"sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
"highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
"mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
},
- "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+ "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
"A String",
],
- "updateTime": "A String", # Output only. Timestamp this resource value config was last updated.
+ "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
}
@@ -245,25 +245,25 @@ Method Details
{ # Response message to list resource value configs
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
"resourceValueConfigs": [ # The resource value configs from the specified parent.
- { # A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
+ { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
"cloudProvider": "A String", # Cloud provider this configuration applies to
- "createTime": "A String", # Output only. Timestamp this resource value config was created.
- "description": "A String", # Description of the resource value config.
- "name": "A String", # Name for the resource value config
- "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+ "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
+ "description": "A String", # Description of the resource value configuration.
+ "name": "A String", # Name for the resource value configuration
+ "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
"a_key": "A String",
},
- "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
+ "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
"resourceValue": "A String", # Required. Resource value level this expression represents
- "scope": "A String", # Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources.
+ "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources.
"sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
"highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
"mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
},
- "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+ "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
"A String",
],
- "updateTime": "A String", # Output only. Timestamp this resource value config was last updated.
+ "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
},
],
}
@@ -288,29 +288,29 @@ Method Details
Updates an existing ResourceValueConfigs with new rules.
Args:
- name: string, Name for the resource value config (required)
+ name: string, Name for the resource value configuration (required)
body: object, The request body.
The object takes the form of:
-{ # A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
+{ # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
"cloudProvider": "A String", # Cloud provider this configuration applies to
- "createTime": "A String", # Output only. Timestamp this resource value config was created.
- "description": "A String", # Description of the resource value config.
- "name": "A String", # Name for the resource value config
- "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+ "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
+ "description": "A String", # Description of the resource value configuration.
+ "name": "A String", # Name for the resource value configuration
+ "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
"a_key": "A String",
},
- "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
+ "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
"resourceValue": "A String", # Required. Resource value level this expression represents
- "scope": "A String", # Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources.
+ "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources.
"sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
"highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
"mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
},
- "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+ "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
"A String",
],
- "updateTime": "A String", # Output only. Timestamp this resource value config was last updated.
+ "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
}
updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
@@ -322,25 +322,25 @@ Method Details
Returns:
An object of the form:
- { # A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
+ { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
"cloudProvider": "A String", # Cloud provider this configuration applies to
- "createTime": "A String", # Output only. Timestamp this resource value config was created.
- "description": "A String", # Description of the resource value config.
- "name": "A String", # Name for the resource value config
- "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+ "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
+ "description": "A String", # Description of the resource value configuration.
+ "name": "A String", # Name for the resource value configuration
+ "resourceLabelsSelector": { # List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
"a_key": "A String",
},
- "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
+ "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
"resourceValue": "A String", # Required. Resource value level this expression represents
- "scope": "A String", # Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources.
+ "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources.
"sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
"highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
"mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
},
- "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+ "tagValues": [ # Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
"A String",
],
- "updateTime": "A String", # Output only. Timestamp this resource value config was last updated.
+ "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
}
diff --git a/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html b/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html
index 6940f548401..9047498620b 100644
--- a/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html
+++ b/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html
@@ -77,12 +77,21 @@ Instance Methods
Close httplib2 connections.
+
+ create(parent, body=None, muteConfigId=None, x__xgafv=None)
+Creates a mute config.
Deletes an existing mute config.
Gets a mute config.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+Lists mute configs.
+
+Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a mute config.
@@ -92,6 +101,45 @@ Method Details
Close httplib2 connections.
+
+ create(parent, body=None, muteConfigId=None, x__xgafv=None)
+ Creates a mute config.
+
+Args:
+ parent: string, Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+}
+
+ muteConfigId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+}
+
+
delete(name, x__xgafv=None)
Deletes an existing mute config.
@@ -135,6 +183,52 @@ Method Details
}
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists mute configs.
+
+Args:
+ parent: string, Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". (required)
+ pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for listing mute configs.
+ "muteConfigs": [ # The mute configs from the specified parent.
+ { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
+ "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
+ "description": "A String", # A description of the mute config.
+ "displayName": "A String", # The human readable name to be displayed for the mute config.
+ "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
+ "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
+ "name": "A String", # This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
+ "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a mute config.
diff --git a/docs/dyn/servicenetworking_v1.services.roles.html b/docs/dyn/servicenetworking_v1.services.roles.html
index 3486254cc6e..7f7f5d8b3ff 100644
--- a/docs/dyn/servicenetworking_v1.services.roles.html
+++ b/docs/dyn/servicenetworking_v1.services.roles.html
@@ -95,7 +95,7 @@ Method Details
"policyBinding": [ # Required. List of policy bindings to add to shared VPC host project.
{ # Grouping of IAM role and IAM member.
"member": "A String", # Required. Member to bind the role with. See /iam/docs/reference/rest/v1/Policy#Binding for how to format each member. Eg. - user:myuser@mydomain.com - serviceAccount:my-service-account@app.gserviceaccount.com
- "role": "A String", # Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project
+ "role": "A String", # Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project
},
],
}
diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html
index 66d7ea216d0..8d716f9e3a7 100644
--- a/docs/dyn/sqladmin_v1.instances.html
+++ b/docs/dyn/sqladmin_v1.instances.html
@@ -1278,9 +1278,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL. # Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -1698,9 +1699,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL. # Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -2080,9 +2082,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL. # Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -2396,9 +2399,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL. # Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -4073,9 +4077,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL. # Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index 3937119f9e2..4bd42ae7b12 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -1278,9 +1278,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. Only applicable to MySQL. # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -1698,9 +1699,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. Only applicable to MySQL. # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -2080,9 +2082,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. Only applicable to MySQL. # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -2396,9 +2399,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. Only applicable to MySQL. # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
@@ -4073,9 +4077,10 @@ Method Details
"replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. Only applicable to MySQL. # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
"drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
"failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
+ "psaWriteEndpoint": "A String", # Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
},
"rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
- "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use.
"scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance.
"canDefer": True or False,
"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
diff --git a/docs/dyn/storagetransfer_v1.transferJobs.html b/docs/dyn/storagetransfer_v1.transferJobs.html
index 36a291596d0..7ea74afa907 100644
--- a/docs/dyn/storagetransfer_v1.transferJobs.html
+++ b/docs/dyn/storagetransfer_v1.transferJobs.html
@@ -123,12 +123,12 @@ Method Details
},
"lastModificationTime": "A String", # Output only. The time that the transfer job was last modified.
"latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration.
- "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "loggingConfig": { # Specifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. # Logging configuration.
+ "enableOnpremGcsTransferLogs": True or False, # For PosixFilesystem transfers, enables [file system transfer logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-format) instead of, or in addition to, Cloud Logging. This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.
+ "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated.
"A String",
],
- "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated.
"A String",
],
},
@@ -325,12 +325,12 @@ Method Details
},
"lastModificationTime": "A String", # Output only. The time that the transfer job was last modified.
"latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration.
- "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "loggingConfig": { # Specifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. # Logging configuration.
+ "enableOnpremGcsTransferLogs": True or False, # For PosixFilesystem transfers, enables [file system transfer logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-format) instead of, or in addition to, Cloud Logging. This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.
+ "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated.
"A String",
],
- "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated.
"A String",
],
},
@@ -554,12 +554,12 @@ Method Details
},
"lastModificationTime": "A String", # Output only. The time that the transfer job was last modified.
"latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration.
- "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "loggingConfig": { # Specifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. # Logging configuration.
+ "enableOnpremGcsTransferLogs": True or False, # For PosixFilesystem transfers, enables [file system transfer logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-format) instead of, or in addition to, Cloud Logging. This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.
+ "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated.
"A String",
],
- "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated.
"A String",
],
},
@@ -768,12 +768,12 @@ Method Details
},
"lastModificationTime": "A String", # Output only. The time that the transfer job was last modified.
"latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration.
- "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "loggingConfig": { # Specifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. # Logging configuration.
+ "enableOnpremGcsTransferLogs": True or False, # For PosixFilesystem transfers, enables [file system transfer logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-format) instead of, or in addition to, Cloud Logging. This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.
+ "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated.
"A String",
],
- "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated.
"A String",
],
},
@@ -990,12 +990,12 @@ Method Details
},
"lastModificationTime": "A String", # Output only. The time that the transfer job was last modified.
"latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration.
- "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "loggingConfig": { # Specifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. # Logging configuration.
+ "enableOnpremGcsTransferLogs": True or False, # For PosixFilesystem transfers, enables [file system transfer logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-format) instead of, or in addition to, Cloud Logging. This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.
+ "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated.
"A String",
],
- "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated.
"A String",
],
},
@@ -1194,12 +1194,12 @@ Method Details
},
"lastModificationTime": "A String", # Output only. The time that the transfer job was last modified.
"latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration.
- "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "loggingConfig": { # Specifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. # Logging configuration.
+ "enableOnpremGcsTransferLogs": True or False, # For PosixFilesystem transfers, enables [file system transfer logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-format) instead of, or in addition to, Cloud Logging. This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.
+ "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated.
"A String",
],
- "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
+ "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated.
"A String",
],
},
diff --git a/docs/dyn/walletobjects_v1.eventticketclass.html b/docs/dyn/walletobjects_v1.eventticketclass.html
index 12c02b58e6a..79117e8a521 100644
--- a/docs/dyn/walletobjects_v1.eventticketclass.html
+++ b/docs/dyn/walletobjects_v1.eventticketclass.html
@@ -165,376 +165,178 @@ Method Details
{
"resource": { # The updated EventTicketClass resource.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "finePrint": { # The fine print, terms, or conditions of the ticket.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -549,36 +351,9 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -615,153 +390,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -776,7 +429,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -791,202 +444,209 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
},
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- },
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "transitOption": "A String",
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the event ticket class with the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
@@ -994,19 +654,7 @@ Method Details
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
@@ -1016,266 +664,108 @@ Method Details
},
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- },
- "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1290,47 +780,7 @@ Method Details
},
],
},
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "finePrint": { # The fine print, terms, or conditions of the ticket.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1345,10 +795,9 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1363,37 +812,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1408,10 +830,37 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1426,18 +875,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1452,79 +893,82 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ ],
},
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
- "contentDescription": { # Description of the image used for accessibility.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1539,10 +983,15 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1557,40 +1006,128 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "messageType": "A String", # The message type.
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "localizedHeader": { # Translated strings for the message header.
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1605,29 +1142,8 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1642,7 +1158,11 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1657,63 +1177,168 @@ Method Details
},
],
},
- },
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
},
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the event ticket class with the given class ID.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1728,29 +1353,178 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1765,22 +1539,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an event ticket class with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2570,100 +2330,342 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
+}
+
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+
+ insert(body=None, x__xgafv=None)
+ Inserts an event ticket class with the given ID and properties.
-Returns:
- An object of the form:
+Args:
+ body: object, The request body.
+ The object takes the form of:
- {
+{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
@@ -2682,7 +2684,9 @@ Method Details
],
},
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
@@ -2701,9 +2705,7 @@ Method Details
],
},
},
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
@@ -2742,20 +2744,60 @@ Method Details
},
},
},
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
@@ -3371,17 +3413,8 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
-
-
- list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all event ticket classes for a given issuer ID.
+}
-Args:
- issuerId: string, The ID of the issuer authorized to list classes.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -3391,95 +3424,1467 @@ Method Details
An object of the form:
{
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+
+
+ list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all event ticket classes for a given issuer ID.
+
+Args:
+ issuerId: string, The ID of the issuer authorized to list classes.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ {
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
@@ -3489,107 +4894,1179 @@ Method Details
},
],
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the event ticket class referenced by the given class ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- },
+ ],
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
- ],
+ },
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- },
+ ],
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
@@ -3597,29 +6074,192 @@ Method Details
},
],
},
- "transitOption": "A String",
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
+ ],
+ },
+ },
+ },
+ "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ ],
+ },
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3634,22 +6274,186 @@ Method Details
},
],
},
- "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
],
},
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3664,7 +6468,25 @@ Method Details
},
],
},
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3679,7 +6501,7 @@ Method Details
},
],
},
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3692,33 +6514,31 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3733,7 +6553,7 @@ Method Details
},
],
},
- "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3748,180 +6568,100 @@ Method Details
},
],
},
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
+ },
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
- "showLastUpdateTime": True or False,
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3936,14 +6676,24 @@ Method Details
},
],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3980,22 +6730,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4010,44 +6751,61 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
+ ],
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4062,7 +6820,16 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4077,44 +6844,42 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
+ ],
},
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4151,26 +6916,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4185,25 +6937,41 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- },
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the event ticket class referenced by the given class ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4448,285 +7216,28 @@ Method Details
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "finePrint": { # The fine print, terms, or conditions of the ticket.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
- "showLastUpdateTime": True or False,
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4741,15 +7252,23 @@ Method Details
},
],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4764,162 +7283,46 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
+ ],
},
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4956,8 +7359,12 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4965,312 +7372,129 @@ Method Details
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
+ },
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
- },
- },
- "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
],
+ "showLastUpdateTime": True or False,
},
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5285,23 +7509,15 @@ Method Details
},
],
},
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5316,46 +7532,162 @@ Method Details
},
],
},
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "finePrint": { # The fine print, terms, or conditions of the ticket.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5392,12 +7724,8 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5412,13 +7740,230 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the event ticket class referenced by the given class ID.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5455,79 +8000,313 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
+ },
+ },
+ "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
],
- "showLastUpdateTime": True or False,
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
+ "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5542,15 +8321,38 @@ Method Details
},
],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5565,162 +8367,46 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
+ ],
},
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5757,8 +8443,12 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5773,262 +8463,122 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the event ticket class referenced by the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
+ },
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
+ ],
},
- "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6043,68 +8593,151 @@ Method Details
},
],
},
- "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6119,46 +8752,26 @@ Method Details
},
],
},
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "finePrint": { # The fine print, terms, or conditions of the ticket.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6195,12 +8808,8 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6215,13 +8824,42 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
{
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6258,120 +8896,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6386,25 +8935,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6419,44 +8950,70 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6471,7 +9028,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6487,62 +9044,69 @@ Method Details
],
},
},
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- },
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6557,29 +9121,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6594,21 +9136,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.eventticketobject.html b/docs/dyn/walletobjects_v1.eventticketobject.html
index 26bbf1980d8..b202d38d40d 100644
--- a/docs/dyn/walletobjects_v1.eventticketobject.html
+++ b/docs/dyn/walletobjects_v1.eventticketobject.html
@@ -167,9 +167,9 @@ Method Details
{
"resource": { # The updated EventTicketObject resource.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -206,7 +206,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -230,7 +230,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -245,7 +245,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -262,7 +262,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -299,7 +299,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -323,7 +323,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -338,7 +338,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -354,8 +354,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -392,7 +392,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -416,7 +416,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -431,7 +431,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -473,6 +473,287 @@ Method Details
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1616,77 +1897,170 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
+ "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
+ "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the event ticket object with the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
- "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
- "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "version": "A String", # Deprecated
- },
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the event ticket object with the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1723,7 +2097,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1747,7 +2121,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1762,7 +2136,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1778,8 +2152,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1816,7 +2190,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1840,7 +2214,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1855,7 +2229,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1871,9 +2245,204 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1888,10 +2457,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1906,90 +2475,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -3133,7 +3695,141 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
+ "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
+ "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts an event ticket object with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3149,49 +3845,8 @@ Method Details
],
},
},
- ],
- "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
- "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
- "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an event ticket object with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3228,7 +3883,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3252,7 +3907,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3267,7 +3922,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3283,8 +3938,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3321,7 +3976,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3345,7 +4000,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3360,7 +4015,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3376,9 +4031,96 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3393,10 +4135,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3411,16 +4168,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3433,68 +4259,85 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4583,47 +5426,273 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
+ "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
+ "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4638,7 +5707,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4654,48 +5723,8 @@ Method Details
],
},
},
- ],
- "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
- "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
- "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4732,7 +5761,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4756,7 +5785,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4771,7 +5800,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4787,9 +5816,96 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4804,10 +5920,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4822,67 +5953,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4897,10 +6028,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4915,90 +6046,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6213,9 +7337,102 @@ Method Details
},
"resources": [ # Resources corresponding to the list request.
{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6252,7 +7469,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6276,7 +7493,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6291,7 +7508,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6307,8 +7524,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6345,7 +7562,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6369,7 +7586,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6384,7 +7601,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6400,9 +7617,96 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6417,10 +7721,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6435,16 +7754,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6459,66 +7847,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -7591,40 +8996,252 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventSeat"`.
+ "row": { # The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
+ "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
+ "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+}
+
+
+
+ modifylinkedofferobjects(resourceId, body=None, x__xgafv=None)
+ Modifies linked offer objects for the event ticket object with the given ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "linkedOfferObjectIds": { # The linked offer object ids to add or remove from the object.
+ "addLinkedOfferObjectIds": [ # The linked offer object ids to add to the object.
+ "A String",
+ ],
+ "removeLinkedOfferObjectIds": [ # The linked offer object ids to remove from the object.
+ "A String",
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventSeat"`.
- "row": { # The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7639,15 +9256,10 @@ Method Details
},
],
},
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7662,7 +9274,16 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7677,11 +9298,10 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
- "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
- "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7696,53 +9316,24 @@ Method Details
},
],
},
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "version": "A String", # Deprecated
},
- ],
-}
-
-
-
- modifylinkedofferobjects(resourceId, body=None, x__xgafv=None)
- Modifies linked offer objects for the event ticket object with the given ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "linkedOfferObjectIds": { # The linked offer object ids to add or remove from the object.
- "addLinkedOfferObjectIds": [ # The linked offer object ids to add to the object.
- "A String",
- ],
- "removeLinkedOfferObjectIds": [ # The linked offer object ids to remove from the object.
- "A String",
- ],
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7779,7 +9370,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -7800,43 +9391,145 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7851,10 +9544,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7869,67 +9562,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7944,10 +9637,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7962,90 +9655,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -9246,9 +10932,9 @@ Method Details
The object takes the form of:
{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9285,7 +10971,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9309,7 +10995,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9324,7 +11010,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9341,7 +11027,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9378,7 +11064,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9402,7 +11088,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9417,7 +11103,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9433,8 +11119,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9471,7 +11157,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9492,66 +11178,347 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -10655,32 +12622,165 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
+ "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
+ "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10695,7 +12795,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10711,48 +12811,8 @@ Method Details
],
},
},
- ],
- "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
- "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
- "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10789,7 +12849,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10813,7 +12873,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10828,7 +12888,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10844,8 +12904,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10882,7 +12942,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10906,7 +12966,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10919,27 +12994,207 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10954,10 +13209,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10972,90 +13227,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -12231,34 +14479,127 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the event ticket object referenced by the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- "version": "A String", # Deprecated
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the event ticket object referenced by the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12295,7 +14636,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12319,7 +14660,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12334,7 +14675,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12350,8 +14691,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12388,7 +14729,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12412,7 +14753,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12427,7 +14768,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12443,9 +14784,96 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12460,10 +14888,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12478,16 +14921,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12500,68 +15012,85 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -13634,63 +16163,289 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventSeat"`.
- "row": { # The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventSeat"`.
+ "row": { # The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
+ "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
+ "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13705,7 +16460,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13721,48 +16476,8 @@ Method Details
],
},
},
- ],
- "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
- "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
- "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -13799,7 +16514,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -13823,7 +16538,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13836,27 +16566,114 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13871,10 +16688,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13889,67 +16706,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13964,10 +16781,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13982,90 +16799,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.flightclass.html b/docs/dyn/walletobjects_v1.flightclass.html
index e286ec15afe..3f0af5497f7 100644
--- a/docs/dyn/walletobjects_v1.flightclass.html
+++ b/docs/dyn/walletobjects_v1.flightclass.html
@@ -165,255 +165,9 @@ Method Details
{
"resource": { # The updated FlightClass resource.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -450,26 +204,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -484,10 +225,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -502,52 +243,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -584,26 +297,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -618,10 +318,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -636,10 +336,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -676,30 +390,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -714,127 +429,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -849,54 +710,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -911,7 +783,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -926,13 +917,52 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -947,10 +977,261 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
@@ -1062,255 +1343,9 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1347,26 +1382,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1381,10 +1403,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1399,52 +1421,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1481,26 +1475,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1515,10 +1496,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1533,10 +1514,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1573,30 +1568,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1611,127 +1607,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1746,54 +1888,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1808,7 +1961,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1823,13 +2095,52 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1844,11 +2155,262 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
@@ -1947,255 +2509,9 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2232,26 +2548,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2266,10 +2569,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2284,52 +2587,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2366,26 +2641,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2400,10 +2662,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2418,10 +2680,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2458,30 +2734,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2496,127 +2773,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2631,54 +3054,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2693,7 +3127,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2708,13 +3261,52 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2729,10 +3321,261 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
@@ -2831,255 +3674,9 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3116,26 +3713,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3150,10 +3734,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3168,52 +3752,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3250,26 +3806,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3284,10 +3827,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3302,10 +3845,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3342,30 +3899,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3380,127 +3938,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3515,54 +4219,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3577,7 +4292,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3592,13 +4426,52 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3613,11 +4486,262 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
@@ -3731,6 +4855,287 @@ Method Details
"resources": [ # Resources corresponding to the list request.
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
"boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
@@ -4619,255 +6024,9 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4904,27 +6063,14 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
@@ -4938,10 +6084,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4956,52 +6102,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5038,26 +6156,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5072,10 +6177,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5090,10 +6195,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5130,30 +6249,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5168,127 +6288,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5303,54 +6569,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5365,7 +6642,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5380,13 +6776,52 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5401,26 +6836,207 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5435,7 +7051,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5450,12 +7066,13 @@ Method Details
},
],
},
+ "messageType": "A String", # The message type.
},
],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5470,10 +7087,26 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5488,21 +7121,355 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
"boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
@@ -5523,213 +7490,544 @@ Method Details
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
+ },
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5744,14 +8042,13 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5787,45 +8084,209 @@ Method Details
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5840,52 +8301,64 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ },
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the flight class referenced by the given class ID.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5922,26 +8395,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5956,10 +8416,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5974,70 +8434,7 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6052,36 +8449,9 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6118,123 +8488,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6249,7 +8527,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6264,62 +8542,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6334,30 +8620,7 @@ Method Details
},
],
},
- },
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6372,23 +8635,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the flight class referenced by the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
"boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
@@ -7071,56 +9319,272 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7135,7 +9599,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7150,47 +9614,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7205,7 +9692,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7221,29 +9708,84 @@ Method Details
],
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7258,21 +9800,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
"boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
diff --git a/docs/dyn/walletobjects_v1.flightobject.html b/docs/dyn/walletobjects_v1.flightobject.html
index 65d2a2c718c..fc2b83aad58 100644
--- a/docs/dyn/walletobjects_v1.flightobject.html
+++ b/docs/dyn/walletobjects_v1.flightobject.html
@@ -164,9 +164,9 @@ Method Details
{
"resource": { # The updated FlightObject resource.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -203,7 +203,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -227,7 +227,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -242,7 +242,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -259,7 +259,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -296,7 +296,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -320,7 +320,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -335,7 +335,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -351,8 +351,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -389,7 +389,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -413,7 +413,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -428,7 +428,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -531,255 +531,9 @@ Method Details
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -816,26 +570,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -850,10 +591,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -868,52 +609,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -950,26 +663,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -984,10 +684,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1002,10 +702,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1042,30 +756,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1080,127 +795,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1215,54 +1076,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1277,77 +1149,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1362,11 +1283,51 @@ Method Details
},
],
},
- },
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1403,34 +1364,12 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1445,34 +1384,14 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1487,18 +1406,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1513,92 +1424,162 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ ],
},
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
},
- "localizedHeader": { # Translated strings for the message header.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1613,22 +1594,61 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1643,49 +1663,36 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1722,83 +1729,142 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
},
- "version": "A String", # Deprecated
- },
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the flight object with the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1813,52 +1879,66 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
+ "messageType": "A String", # The message type.
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1873,7 +1953,21 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1888,10 +1982,10 @@ Method Details
},
],
},
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1906,14 +2000,201 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the flight object with the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
@@ -1927,7 +2208,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1951,7 +2232,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1966,7 +2247,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1982,8 +2263,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2020,7 +2301,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2044,7 +2325,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2059,7 +2340,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2162,255 +2443,102 @@ Method Details
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2447,27 +2575,14 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
@@ -2481,10 +2596,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2499,52 +2614,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2581,26 +2668,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2615,10 +2689,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2633,70 +2707,7 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2711,127 +2722,258 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2846,54 +2988,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2908,7 +3061,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2923,82 +3195,52 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3034,34 +3276,12 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3076,34 +3296,14 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3118,18 +3318,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3144,92 +3336,162 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ ],
},
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
},
- "localizedHeader": { # Translated strings for the message header.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3244,22 +3506,61 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3274,49 +3575,36 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3353,84 +3641,26 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an flight object with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
@@ -3453,64 +3683,59 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3525,52 +3750,33 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3585,7 +3791,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3600,70 +3806,98 @@ Method Details
},
],
},
+ "messageType": "A String", # The message type.
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
},
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3678,7 +3912,17 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3693,36 +3937,7 @@ Method Details
},
],
},
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
- "contentDescription": { # Description of the image used for accessibility.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3737,10 +3952,34 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts an flight object with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3755,259 +3994,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4022,15 +4069,28 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4045,29 +4105,16 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4082,28 +4129,43 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4118,11 +4180,10 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4137,33 +4198,154 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4200,26 +4382,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4234,10 +4403,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4252,10 +4421,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4292,30 +4475,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4330,36 +4514,24 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4396,123 +4568,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4527,7 +4607,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4542,82 +4622,235 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
},
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4632,79 +4865,88 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4719,10 +4961,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4737,18 +4980,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4763,7 +5040,29 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4778,21 +5077,10 @@ Method Details
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4807,33 +5095,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
},
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4848,37 +5155,33 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "messageType": "A String", # The message type.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4893,50 +5196,129 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
},
],
+ "showLastUpdateTime": True or False,
},
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
- "contentDescription": { # Description of the image used for accessibility.
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4951,50 +5333,65 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5009,33 +5406,26 @@ Method Details
},
],
},
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
},
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5050,67 +5440,27 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5125,10 +5475,10 @@ Method Details
},
],
},
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5143,67 +5493,37 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
+ },
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5218,9 +5538,15 @@ Method Details
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5257,31 +5583,115 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5296,7 +5706,22 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5311,11 +5736,19 @@ Method Details
},
],
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
},
- "barcode": { # The barcode type and value.
+ "rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5332,15 +5765,39 @@ Method Details
},
],
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
- "contentDescription": { # Description of the image used for accessibility.
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5355,10 +5812,73 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5373,259 +5893,297 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
+ ],
},
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "transitOption": "A String",
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5640,14 +6198,53 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5684,26 +6281,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5718,10 +6302,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5736,52 +6320,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5818,26 +6374,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5852,10 +6395,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5870,10 +6413,24 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5910,30 +6467,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5948,127 +6506,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- ],
- "showLastUpdateTime": True or False,
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6083,54 +6787,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6145,62 +6860,126 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6215,26 +6994,51 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6271,34 +7075,12 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6313,34 +7095,14 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6355,18 +7117,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6381,92 +7135,162 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ ],
},
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
},
- "localizedHeader": { # Translated strings for the message header.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6481,22 +7305,61 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6511,49 +7374,36 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6590,161 +7440,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- list(classId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all flight objects for a given issuer ID.
-
-Args:
- classId: string, The ID of the class whose objects will be listed.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6759,10 +7479,18 @@ Method Details
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6777,85 +7505,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6870,88 +7520,21 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
+ ],
},
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6966,300 +7549,2094 @@ Method Details
},
],
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ list(classId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all flight objects for a given issuer ID.
+
+Args:
+ classId: string, The ID of the class whose objects will be listed.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "transitOption": "A String",
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7274,282 +9651,163 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
+ ],
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the flight object referenced by the given object ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7564,29 +9822,105 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
@@ -7607,127 +9941,85 @@ Method Details
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7742,29 +10034,54 @@ Method Details
},
],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7779,7 +10096,16 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7794,13 +10120,43 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7815,26 +10171,10 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7849,7 +10189,16 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7864,11 +10213,42 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7905,16 +10285,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7929,284 +10324,273 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
+ },
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
+ "transitOption": "A String",
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8221,17 +10605,29 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8246,52 +10642,28 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
- },
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the flight object referenced by the given object ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8306,10 +10678,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8324,85 +10697,34 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8417,16 +10739,29 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8441,43 +10776,28 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8492,10 +10812,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8510,92 +10831,32 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8620,268 +10881,366 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "transitOption": "A String",
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8894,17 +11253,36 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8919,10 +11297,18 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8937,29 +11323,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8974,10 +11338,264 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8992,11 +11610,10 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9011,34 +11628,16 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9053,65 +11652,43 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9126,11 +11703,10 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9145,33 +11721,49 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9186,10 +11778,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9204,37 +11796,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9249,78 +11814,12 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
@@ -9341,88 +11840,23 @@ Method Details
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
+ ],
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9437,60 +11871,35 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9527,16 +11936,8 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9551,34 +11952,92 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9593,10 +12052,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9611,18 +12070,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9637,7 +12088,16 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9652,21 +12112,103 @@ Method Details
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9681,194 +12223,250 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "messageType": "A String", # The message type.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
- },
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9883,51 +12481,15 @@ Method Details
},
],
},
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9942,16 +12504,29 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9966,43 +12541,28 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10017,10 +12577,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10035,16 +12596,34 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10059,43 +12638,65 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10110,10 +12711,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10128,92 +12730,32 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ },
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10250,256 +12792,12 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10514,14 +12812,13 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10558,8 +12855,61 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10574,28 +12924,177 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10610,53 +13109,79 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
- },
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10671,10 +13196,18 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10689,29 +13222,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10726,10 +13237,21 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- },
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10744,52 +13266,33 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10804,33 +13307,37 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
+ "messageType": "A String", # The message type.
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10845,129 +13352,50 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
- "showLastUpdateTime": True or False,
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10982,65 +13410,50 @@ Method Details
},
],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "messageType": "A String", # The message type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11055,26 +13468,35 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the flight object referenced by the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11089,27 +13511,52 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11124,55 +13571,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11187,15 +13586,9 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -11232,100 +13625,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11340,7 +13664,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11355,98 +13679,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11461,17 +13757,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11486,7 +13772,36 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11501,35 +13816,10 @@ Method Details
},
],
},
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the flight object referenced by the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11544,10 +13834,36 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11562,67 +13878,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11637,10 +13953,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11655,67 +13971,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11730,10 +14046,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11748,111 +14064,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11867,32 +14139,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
"boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
@@ -13079,19 +15327,228 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13106,7 +15563,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13122,31 +15579,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -13183,7 +15617,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -13207,7 +15641,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13222,7 +15656,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13238,9 +15672,53 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13255,10 +15733,129 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13273,67 +15870,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13348,10 +15945,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13366,111 +15963,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13485,32 +16038,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
"boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
diff --git a/docs/dyn/walletobjects_v1.genericclass.html b/docs/dyn/walletobjects_v1.genericclass.html
index 0446008e69a..1e190124c67 100644
--- a/docs/dyn/walletobjects_v1.genericclass.html
+++ b/docs/dyn/walletobjects_v1.genericclass.html
@@ -164,230 +164,9 @@ Method Details
{ # Response to adding a new issuer message to the class. This contains the entire updated GenericClass.
"resource": { # Generic Class # The updated EventTicketClass resource.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
- "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
- "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -424,49 +203,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -481,7 +242,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -496,22 +257,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -526,7 +335,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -542,173 +351,267 @@ Method Details
],
},
},
- ],
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
- },
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the generic class with the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Generic Class
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- },
+ ],
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
},
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
},
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
@@ -728,37 +631,29 @@ Method Details
},
},
},
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
+ "transitOption": "A String",
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
@@ -766,51 +661,59 @@ Method Details
},
],
},
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
},
},
- },
- "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
- "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
- "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
+ "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
+ "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ ],
+ "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -825,18 +728,26 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
+ ],
},
- ],
- "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -851,339 +762,96 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "messageType": "A String", # The message type.
},
- "messageType": "A String", # The message type.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- ],
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+ ],
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+ },
}
- insert(body=None, x__xgafv=None)
- Inserts a generic class with the given ID and properties.
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the generic class with the given class ID.
Args:
- body: object, The request body.
- The object takes the form of:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
-{ # Generic Class
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
- "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
- "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+Returns:
+ An object of the form:
+
+ { # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1220,49 +888,124 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1277,7 +1020,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1292,22 +1035,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1322,7 +1113,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1338,19 +1129,7 @@ Method Details
],
},
},
- ],
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Generic Class
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1735,347 +1514,2930 @@ Method Details
- list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all generic classes for a given issuer ID.
+ insert(body=None, x__xgafv=None)
+ Inserts a generic class with the given ID and properties.
Args:
- issuerId: string, The ID of the issuer authorized to list classes.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
+ body: object, The request body.
+ The object takes the form of:
- { # List response which contains the list of all generic classes for a given issuer ID.
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- { # Generic Class
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+{ # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
+ "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
+ "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
+ "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
+ "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+}
+
+
+
+ list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all generic classes for a given issuer ID.
+
+Args:
+ issuerId: string, The ID of the issuer authorized to list classes.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List response which contains the list of all generic classes for a given issuer ID.
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ { # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
+ "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
+ "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the generic class referenced by the given class ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
+ "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
+ "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
- "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
- "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2090,22 +4452,16 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
},
- "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2120,39 +4476,41 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the generic class referenced by the given class ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Generic Class
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2351,32 +4709,204 @@ Method Details
},
],
},
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
+ "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
+ "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
- },
- "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
- "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
- "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ ],
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the Generic class referenced by the given class ID.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2413,15 +4943,64 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- ],
- "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2436,26 +5015,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2470,7 +5075,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2485,22 +5090,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2515,7 +5168,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2531,19 +5184,7 @@ Method Details
],
},
},
- ],
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Generic Class
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2892,275 +5533,52 @@ Method Details
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the Generic class referenced by the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Generic Class
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
- },
- "enableSmartTap": True or False, # Available only to Smart Tap enabled partners. Contact support for additional guidance.
- "id": "A String", # Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
- "imageModulesData": [ # Image module data. If `imageModulesData` is also defined on the object, both will be displayed. Only one of the image from class and one from object level will be rendered when both set.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ ],
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Generic Class
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3197,15 +5615,64 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- ],
- "linksModuleData": { # Links module data. If `linksModuleData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3220,26 +5687,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3254,7 +5747,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3269,22 +5762,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3299,7 +5840,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3315,19 +5856,7 @@ Method Details
],
},
},
- ],
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the generic pass.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Generic Class
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.genericobject.html b/docs/dyn/walletobjects_v1.genericobject.html
index dc864a8578c..545fd8b155c 100644
--- a/docs/dyn/walletobjects_v1.genericobject.html
+++ b/docs/dyn/walletobjects_v1.genericobject.html
@@ -164,9 +164,9 @@ Method Details
{ # Response to adding a new issuer message to the object. This contains the entire updated GenericObject.
"resource": { # Generic Object # The updated GenericObject resource.
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -203,7 +203,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -227,7 +227,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -242,7 +242,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -259,7 +259,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -296,7 +296,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -320,7 +320,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -335,7 +335,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -351,8 +351,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -389,7 +389,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -413,7 +413,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -428,7 +428,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -823,9 +823,9 @@ Method Details
An object of the form:
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -862,7 +862,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -886,7 +886,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -901,7 +901,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -918,7 +918,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -955,7 +955,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -979,7 +979,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -994,7 +994,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1010,8 +1010,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1048,7 +1048,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1072,7 +1072,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1087,7 +1087,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1470,9 +1470,9 @@ Method Details
The object takes the form of:
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1509,7 +1509,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1533,7 +1533,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1548,7 +1548,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1565,7 +1565,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1602,7 +1602,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1626,7 +1626,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1641,7 +1641,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1657,8 +1657,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1695,7 +1695,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1719,7 +1719,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1734,7 +1734,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2116,9 +2116,9 @@ Method Details
An object of the form:
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2155,7 +2155,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2179,7 +2179,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2194,7 +2194,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2211,7 +2211,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2248,7 +2248,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2272,7 +2272,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2287,7 +2287,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2303,8 +2303,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2341,7 +2341,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2365,7 +2365,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2380,7 +2380,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2778,9 +2778,9 @@ Method Details
},
"resources": [ # Resources corresponding to the list request.
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2817,7 +2817,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2841,7 +2841,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2856,7 +2856,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2873,7 +2873,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2910,7 +2910,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2934,7 +2934,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2949,7 +2949,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2965,8 +2965,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3003,7 +3003,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3027,7 +3027,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3042,7 +3042,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3428,9 +3428,9 @@ Method Details
The object takes the form of:
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3467,7 +3467,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3491,7 +3491,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3506,7 +3506,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3523,7 +3523,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3560,7 +3560,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3584,7 +3584,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3599,7 +3599,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3615,8 +3615,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3653,7 +3653,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3677,7 +3677,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3692,7 +3692,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4074,9 +4074,9 @@ Method Details
An object of the form:
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4113,7 +4113,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4137,7 +4137,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4152,7 +4152,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4169,7 +4169,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4206,7 +4206,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4230,7 +4230,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4245,7 +4245,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4261,8 +4261,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4299,7 +4299,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4323,7 +4323,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4338,7 +4338,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4722,9 +4722,9 @@ Method Details
The object takes the form of:
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4761,7 +4761,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4785,7 +4785,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4800,7 +4800,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4817,7 +4817,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4854,7 +4854,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4878,7 +4878,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4893,7 +4893,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4909,8 +4909,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4947,7 +4947,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4971,7 +4971,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4986,7 +4986,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5368,9 +5368,9 @@ Method Details
An object of the form:
{ # Generic Object
- "appLinkData": { # Information about the partner app link. The maximum number of these fields displayed is 10.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5407,7 +5407,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -5431,7 +5431,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5446,7 +5446,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5463,7 +5463,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5500,7 +5500,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -5524,7 +5524,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5539,7 +5539,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5555,8 +5555,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5593,7 +5593,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -5617,7 +5617,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5632,7 +5632,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
diff --git a/docs/dyn/walletobjects_v1.giftcardclass.html b/docs/dyn/walletobjects_v1.giftcardclass.html
index f1fab9ffe76..6b78093a93c 100644
--- a/docs/dyn/walletobjects_v1.giftcardclass.html
+++ b/docs/dyn/walletobjects_v1.giftcardclass.html
@@ -166,248 +166,163 @@ Method Details
"resource": { # The updated GiftCardClass resource.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
},
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -422,36 +337,24 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -488,158 +391,536 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "localizedCardNumberLabel": { # Translated strings for the card_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- ],
- },
- "localizedEventNumberLabel": { # Translated strings for the event_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "localizedPinLabel": { # Translated strings for the pin_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedCardNumberLabel": { # Translated strings for the card_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedEventNumberLabel": { # Translated strings for the event_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedPinLabel": { # Translated strings for the pin_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
@@ -879,248 +1160,163 @@ Method Details
{
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1135,36 +1331,24 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1201,154 +1385,532 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "localizedCardNumberLabel": { # Translated strings for the card_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- ],
- },
- "localizedEventNumberLabel": { # Translated strings for the event_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "localizedPinLabel": { # Translated strings for the pin_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedCardNumberLabel": { # Translated strings for the card_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedEventNumberLabel": { # Translated strings for the event_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedPinLabel": { # Translated strings for the pin_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
@@ -1580,38 +2142,319 @@ Method Details
{
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
@@ -2280,248 +3123,163 @@ Method Details
{
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2536,36 +3294,24 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2602,160 +3348,538 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "localizedCardNumberLabel": { # Translated strings for the card_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- ],
- },
- "localizedEventNumberLabel": { # Translated strings for the event_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "localizedPinLabel": { # Translated strings for the pin_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedCardNumberLabel": { # Translated strings for the card_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedEventNumberLabel": { # Translated strings for the event_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedPinLabel": { # Translated strings for the pin_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
@@ -2962,40 +4086,321 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+
+
+ list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all gift card classes for a given issuer ID.
+
+Args:
+ issuerId: string, The ID of the issuer authorized to list classes.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ {
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
-}
-
-
-
- list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all gift card classes for a given issuer ID.
-
-Args:
- issuerId: string, The ID of the issuer authorized to list classes.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- {
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -3590,7 +4995,255 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the gift card class referenced by the given class ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3605,11 +5258,42 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3646,26 +5330,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3680,26 +5351,41 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the gift card class referenced by the given class ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4222,12 +5908,135 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4264,22 +6073,83 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4294,7 +6164,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4310,29 +6180,84 @@ Method Details
],
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4347,29 +6272,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4384,22 +6365,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4884,15 +6851,288 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the gift card class referenced by the given class ID.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4907,7 +7147,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4922,64 +7162,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4994,7 +7240,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5010,29 +7256,69 @@ Method Details
],
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5047,29 +7333,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5084,24 +7348,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the gift card class referenced by the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -5586,15 +7834,286 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5609,7 +8128,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5624,64 +8143,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5696,7 +8221,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5712,29 +8237,69 @@ Method Details
],
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5749,29 +8314,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5786,22 +8329,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.giftcardobject.html b/docs/dyn/walletobjects_v1.giftcardobject.html
index 05c7b10e079..361548ad0cf 100644
--- a/docs/dyn/walletobjects_v1.giftcardobject.html
+++ b/docs/dyn/walletobjects_v1.giftcardobject.html
@@ -164,9 +164,9 @@ Method Details
{
"resource": { # The updated GiftCardObject resource.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -203,7 +203,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -227,7 +227,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -242,7 +242,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -259,7 +259,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -296,7 +296,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -320,7 +320,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -335,7 +335,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -351,8 +351,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -389,7 +389,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -413,7 +413,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -428,7 +428,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -480,6 +480,287 @@ Method Details
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1453,54 +1734,147 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the gift card object with the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "version": "A String", # Deprecated
- },
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the gift card object with the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1537,7 +1911,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1561,7 +1935,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1576,7 +1950,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1592,8 +1966,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1630,7 +2004,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1654,7 +2028,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1669,25 +2043,230 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1702,10 +2281,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1720,100 +2299,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2753,20 +3315,137 @@ Method Details
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts an gift card object with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2781,7 +3460,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2797,32 +3476,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an gift card object with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2859,7 +3514,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2883,7 +3538,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2898,7 +3553,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2914,8 +3569,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2952,7 +3607,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2976,7 +3631,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2991,25 +3646,230 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3024,10 +3884,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3042,100 +3902,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4075,20 +4918,136 @@ Method Details
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4103,7 +5062,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4119,31 +5078,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4180,7 +5116,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4204,7 +5140,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4219,7 +5155,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4235,8 +5171,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4273,7 +5209,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4297,7 +5233,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4312,7 +5248,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4328,9 +5264,106 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4345,34 +5378,118 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4387,76 +5504,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -5437,50 +6561,143 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- list(classId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all gift card objects for a given issuer ID.
-
-Args:
- classId: string, The ID of the class whose objects will be listed.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ list(classId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all gift card objects for a given issuer ID.
+
+Args:
+ classId: string, The ID of the class whose objects will be listed.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5517,7 +6734,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -5541,7 +6758,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5556,7 +6773,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5572,8 +6789,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5610,7 +6827,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -5634,7 +6851,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5649,7 +6866,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5665,9 +6882,106 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5682,10 +6996,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5700,16 +7029,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5722,78 +7120,85 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6691,27 +8096,215 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "pin": "A String", # The card's PIN.
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the gift card object referenced by the given object ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
- "pin": "A String", # The card's PIN.
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6726,27 +8319,10 @@ Method Details
},
],
},
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
- },
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6761,7 +8337,16 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6776,36 +8361,42 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "version": "A String", # Deprecated
},
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the gift card object referenced by the given object ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6842,7 +8433,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6863,43 +8454,155 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6914,10 +8617,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6932,67 +8635,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7007,10 +8710,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7025,100 +8728,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -8124,9 +9810,9 @@ Method Details
An object of the form:
{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8163,7 +9849,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -8187,7 +9873,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8202,7 +9888,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8219,7 +9905,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8256,7 +9942,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -8280,7 +9966,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8295,7 +9981,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8311,8 +9997,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8349,7 +10035,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -8373,7 +10059,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8388,7 +10074,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8430,16 +10116,297 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -9279,35 +11246,238 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "pin": "A String", # The card's PIN.
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the gift card object referenced by the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9322,7 +11492,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9337,62 +11507,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "pin": "A String", # The card's PIN.
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9407,7 +11585,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9423,33 +11601,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the gift card object referenced by the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9486,7 +11639,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9507,43 +11660,155 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9558,10 +11823,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9576,67 +11841,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9651,10 +11916,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9669,100 +11934,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -10627,10 +12875,211 @@ Method Details
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "pin": "A String", # The card's PIN.
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10645,7 +13094,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10660,62 +13109,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "pin": "A String", # The card's PIN.
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10730,7 +13187,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10746,31 +13203,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10807,7 +13241,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10831,7 +13265,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10844,27 +13293,124 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "cardNumber": "A String", # Required. The card's number.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10879,10 +13425,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10897,67 +13443,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10972,10 +13518,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10990,100 +13536,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.jwt.html b/docs/dyn/walletobjects_v1.jwt.html
index 6e62fb98028..51baac9be38 100644
--- a/docs/dyn/walletobjects_v1.jwt.html
+++ b/docs/dyn/walletobjects_v1.jwt.html
@@ -111,376 +111,178 @@ Method Details
"eventTicketClasses": [
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "finePrint": { # The fine print, terms, or conditions of the ticket.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -495,36 +297,9 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -561,153 +336,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -722,7 +375,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -737,252 +390,378 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
},
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
},
],
},
- },
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
- },
- ],
- "eventTicketObjects": [
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
+ ],
+ },
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ ],
+ },
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -997,9 +776,36 @@ Method Details
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1036,35 +842,124 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
@@ -1075,7 +970,25 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1090,70 +1003,44 @@ Method Details
},
],
},
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
+ ],
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1168,7 +1055,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1184,12 +1071,25 @@ Method Details
],
},
},
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1204,233 +1104,48 @@ Method Details
},
],
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
},
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1445,141 +1160,35 @@ Method Details
},
],
},
- "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "dateTime": { # The date & time information of the event.
- "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
- "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
- "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
- "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "finePrint": { # The fine print, terms, or conditions of the ticket.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ },
+ ],
+ "eventTicketObjects": [
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1594,37 +1203,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1639,77 +1221,12 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
@@ -1730,32 +1247,23 @@ Method Details
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1770,10 +1278,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1788,110 +1296,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
- "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
- "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- ],
- "venue": { # Event venue details.
- "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1906,8 +1356,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
- "name": { # The name of the venue, such as "AT&T Park". This is required.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1923,28 +1372,9 @@ Method Details
],
},
},
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1959,11 +1389,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1978,42 +1449,28 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
},
},
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
- "faceValue": { # The face value of the ticket, matching what would be printed on a physical version of the ticket.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2028,34 +1485,76 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2070,10 +1569,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2088,18 +1602,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2114,7 +1620,16 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2129,24 +1644,10 @@ Method Details
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketObject"`.
- "linkedOfferIds": [ # A list of offer objects linked to this event ticket. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
- "A String",
- ],
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2161,86 +1662,337 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "messageType": "A String", # The message type.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "reservationInfo": { # Reservation details for this ticket. This is expected to be shared amongst all tickets that were purchased in the same order.
- "confirmationCode": "A String", # The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventReservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "confirmationCodeLabel": "A String", # The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2255,21 +2007,7 @@ Method Details
},
],
},
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
- },
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "seatInfo": { # Seating details for this ticket.
- "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "customGateLabel": { # A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2284,8 +2022,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventSeat"`.
- "row": { # The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "customRowLabel": { # A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2300,7 +2037,7 @@ Method Details
},
],
},
- "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "customSeatLabel": { # A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2315,7 +2052,7 @@ Method Details
},
],
},
- "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "customSectionLabel": { # A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2330,15 +2067,8 @@ Method Details
},
],
},
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "dateTime": { # The date & time information of the event.
+ "customDoorsOpenLabel": { # A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2353,7 +2083,47 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "doorsOpen": "A String", # The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "doorsOpenLabel": "A String", # The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
+ "end": "A String", # The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
+ "start": "A String", # The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventId": "A String", # The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
+ "eventName": { # Required. The name of the event, such as "LA Dodgers at SF Giants".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "finePrint": { # The fine print, terms, or conditions of the ticket.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gateLabel": "A String", # The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2368,267 +2138,163 @@ Method Details
},
],
},
- },
- ],
- "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
- "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
- "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
- },
- ],
- "flightClasses": [
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
},
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
+ ],
},
],
+ "showLastUpdateTime": True or False,
},
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
{
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2643,15 +2309,33 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2666,29 +2350,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2703,47 +2383,44 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "messageType": "A String", # The message type.
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rowLabel": "A String", # The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
+ "seatLabel": "A String", # The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
+ "sectionLabel": "A String", # The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2758,34 +2435,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2800,29 +2450,63 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ },
+ ],
+ "venue": { # Event venue details.
+ "address": { # The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (`\n`) characters. This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventVenue"`.
+ "name": { # The name of the venue, such as "AT&T Park". This is required.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the event ticket.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2837,28 +2521,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2873,11 +2540,10 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2892,32 +2558,23 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
},
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
+ "faceValue": { # The face value of the ticket, matching what would be printed on a physical version of the ticket.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2955,28 +2612,7 @@ Method Details
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
@@ -3062,10 +2698,11 @@ Method Details
],
"showLastUpdateTime": True or False,
},
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketObject"`.
+ "linkedOfferIds": [ # A list of offer objects linked to this event ticket. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
+ "A String",
+ ],
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3090,27 +2727,6 @@ Method Details
},
],
},
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
@@ -3166,10 +2782,27 @@ Method Details
"messageType": "A String", # The message type.
},
],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "reservationInfo": { # Reservation details for this ticket. This is expected to be shared amongst all tickets that were purchased in the same order.
+ "confirmationCode": "A String", # The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventReservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3184,20 +2817,84 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "seatInfo": { # Seating details for this ticket.
+ "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventSeat"`.
+ "row": { # The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "seat": { # The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "section": { # The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
@@ -3235,52 +2932,41 @@ Method Details
},
},
],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "ticketHolderName": "A String", # Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
+ "ticketNumber": "A String", # The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
+ "ticketType": { # The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
+ "version": "A String", # Deprecated
},
],
- "flightObjects": [
+ "flightClasses": [
{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3317,7 +3003,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3341,7 +3027,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3356,7 +3042,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3373,7 +3059,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3410,7 +3096,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3434,7 +3120,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3449,7 +3135,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3465,8 +3151,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3503,7 +3189,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3527,7 +3213,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3542,7 +3228,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3559,264 +3245,152 @@ Method Details
},
},
},
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
},
- "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
- "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
- "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
- "boardingPosition": "A String", # The value of boarding position. eg: "76"
- "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
- "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
- "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
- "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
- "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
- "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
- },
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
@@ -3836,29 +3410,37 @@ Method Details
},
},
},
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
@@ -3866,72 +3448,71 @@ Method Details
},
],
},
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "destination": { # Required. Destination airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "flightHeader": { # Required. Information about the flight carrier and number.
- "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ ],
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3946,28 +3527,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3982,11 +3546,10 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4001,34 +3564,47 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
- "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
- "operatingCarrier": { # Information about operating airline carrier.
- "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
- "contentDescription": { # Description of the image used for accessibility.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4043,29 +3619,34 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4080,28 +3661,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4116,11 +3680,10 @@ Method Details
},
],
},
- "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
- "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
- "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4135,33 +3698,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
- },
- "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4176,10 +3716,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4194,15 +3735,51 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4217,32 +3794,81 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4257,126 +3883,38 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
- "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
- "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
- "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ ],
},
],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4391,28 +3929,69 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
+ ],
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "origin": { # Required. Origin airport.
- "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
- "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4427,61 +4006,47 @@ Method Details
},
],
},
- "gate": "A String", # A name of the gate. Eg: "B59" or "59"
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
- "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
+ "messageType": "A String", # The message type.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4496,36 +4061,26 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
},
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4562,12 +4117,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ },
+ ],
+ "flightObjects": [
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4604,100 +4160,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4712,7 +4199,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4727,98 +4214,85 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
- "reservationInfo": { # Required. Information about flight reservation.
- "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
- "eticketNumber": "A String", # E-ticket number.
- "frequentFlyerInfo": { # Frequent flyer membership information.
- "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
- "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4833,17 +4307,70 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4858,7 +4385,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4874,265 +4401,35 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
- },
- ],
- "giftCardClasses": [
- {
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
- "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
- },
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
- {
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- ],
- },
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
+ ],
},
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "boardingAndSeatingInfo": { # Passenger specific information about boarding and seating.
+ "boardingDoor": "A String", # Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
+ "boardingGroup": "A String", # The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
+ "boardingPosition": "A String", # The value of boarding position. eg: "76"
+ "boardingPrivilegeImage": { # Wrapping type for Google hosted images. Next ID: 7 # A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5147,15 +4444,29 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
+ "seatAssignment": { # The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5170,32 +4481,17 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "seatClass": "A String", # The value of the seat class. eg: "Economy" or "Economy Plus"
+ "seatNumber": "A String", # The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
+ "sequenceNumber": "A String", # The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5210,18 +4506,10 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5236,7 +4524,16 @@ Method Details
},
],
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5251,22 +4548,10 @@ Method Details
},
],
},
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5281,311 +4566,193 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localizedCardNumberLabel": { # Translated strings for the card_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedEventNumberLabel": { # Translated strings for the event_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedPinLabel": { # Translated strings for the pin_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- },
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "giftCardObjects": [
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5600,67 +4767,235 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ },
+ "boardingAndSeatingPolicy": { # Policies for boarding and seating. These will inform which labels will be shown to users.
+ "boardingPolicy": "A String", # Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
+ "seatClassPolicy": "A String", # Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "destination": { # Required. Destination airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5675,28 +5010,15 @@ Method Details
},
],
},
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "flightHeader": { # Required. Information about the flight carrier and number.
+ "carrier": { # Information about airline carrier. This is a required property of `flightHeader`.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5711,22 +5033,35 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5735,43 +5070,28 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5786,10 +5106,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5804,16 +5125,34 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "flightNumber": "A String", # The flight number without IATA carrier code. This field should contain only digits. This is a required property of `flightHeader`. eg: "123"
+ "flightNumberDisplayOverride": "A String", # Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightHeader"`.
+ "operatingCarrier": { # Information about operating airline carrier.
+ "airlineAllianceLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5828,25 +5167,125 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "airlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "airlineName": { # A localized name of the airline specified by carrierIataCode. If unset, `issuer_name` or `localized_issuer_name` from `FlightClass` will be used for display purposes. eg: "Swiss Air" for "LX"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "carrierIataCode": "A String", # Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIcaoCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "LX" for Swiss Air
+ "carrierIcaoCode": "A String", # Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or `carrierIataCode` needs to be provided for `carrier` and `operatingCarrier`. eg: "EZY" for Easy Jet
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightCarrier"`.
+ "wideAirlineLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "operatingFlightNumber": "A String", # The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"
+ },
+ "flightStatus": "A String", # Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5861,21 +5300,170 @@ Method Details
},
],
},
- },
- },
- "balance": { # The card's monetary balance.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`.
+ "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
+ "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
+ "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5890,237 +5478,133 @@ Method Details
},
],
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "cardNumber": "A String", # Required. The card's number.
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
+ "messageType": "A String", # The message type.
},
- "cardTemplateOverride": { # Override for the card view.
- "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
- {
- "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
- "item": { # The item to be displayed in the row. This item will be automatically centered.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
- "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- },
- },
- ],
- },
- "detailsTemplateOverride": { # Override for the details view (beneath the card view).
- "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "origin": { # Required. Origin airport.
+ "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
+ "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
{
- "item": { # The item to be displayed in the details list.
- "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
- "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ "gate": "A String", # A name of the gate. Eg: "B59" or "59"
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
+ "terminal": "A String", # Terminal name. Eg: "INTL" or "I"
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "transitOption": "A String",
- },
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the boarding pass.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6157,13 +5641,35 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
@@ -6177,14 +5683,34 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6199,10 +5725,18 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6217,82 +5751,151 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ ],
},
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "passengerName": "A String", # Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
+ "reservationInfo": { # Required. Information about flight reservation.
+ "confirmationCode": "A String", # Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
+ "eticketNumber": "A String", # E-ticket number.
+ "frequentFlyerInfo": { # Frequent flyer membership information.
+ "frequentFlyerNumber": "A String", # Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`.
+ "frequentFlyerProgramName": { # Frequent flyer program name. eg: "Lufthansa Miles & More"
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
],
},
- "localizedCardNumberLabel": { # Translated strings for the card_number_label.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6307,37 +5910,21 @@ Method Details
},
],
},
- "localizedEventNumberLabel": { # Translated strings for the event_number_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
- "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6352,81 +5939,50 @@ Method Details
},
],
},
- "localizedPinLabel": { # Translated strings for the pin_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
+ ],
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6441,10 +5997,28 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+ "giftCardClasses": [
+ {
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6459,60 +6033,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6527,29 +6093,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6564,11 +6108,11 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
@@ -6582,38 +6126,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
- "eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6628,14 +6201,9 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6672,100 +6240,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6780,7 +6279,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6795,146 +6294,45 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
- "pin": "A String", # The card's PIN.
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
- },
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
- },
- ],
- "loyaltyClasses": [
- {
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
- "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
@@ -7118,59 +6516,8 @@ Method Details
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "discoverableProgram": { # Information about how a class may be discovered and instantiated from within the Android Pay app. This is done by searching for a loyalty or gift card program and scanning or manually entering. # Information about how the class may be discovered and instantiated from within the Google Pay app.
- "merchantSigninInfo": { # Information about the merchant hosted signin flow for a program. # Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
- "signinWebsite": { # The URL to direct the user to for the merchant's signin site.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "merchantSignupInfo": { # Information about the merchant hosted signup flow for a program. # Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
- "signupSharedDatas": [ # User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.
- "A String",
- ],
- "signupWebsite": { # The URL to direct the user to for the merchant's signup site.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "state": "A String", # Visibility state of the discoverable program.
- },
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and one of object level `smartTapRedemptionLevel`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7317,7 +6664,7 @@ Method Details
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
@@ -7343,7 +6690,7 @@ Method Details
},
],
},
- "localizedAccountIdLabel": { # Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7358,7 +6705,7 @@ Method Details
},
],
},
- "localizedAccountNameLabel": { # Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7388,52 +6735,7 @@ Method Details
},
],
},
- "localizedProgramName": { # Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedRewardsTier": { # Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedRewardsTierLabel": { # Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedSecondaryRewardsTier": { # Translated strings for the secondary_rewards_tier.
+ "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7448,7 +6750,7 @@ Method Details
},
],
},
- "localizedSecondaryRewardsTierLabel": { # Translated strings for the secondary_rewards_tier_label.
+ "localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7470,6 +6772,7 @@ Method Details
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
+ "merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
@@ -7519,7 +6822,8 @@ Method Details
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
+ "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7556,18 +6860,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
- "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
- "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
- "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
@@ -7609,8 +6908,8 @@ Method Details
},
],
"version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7686,13 +6985,11 @@ Method Details
},
},
],
- "loyaltyObjects": [
+ "giftCardObjects": [
{
- "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
- "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7729,7 +7026,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -7753,7 +7050,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7768,7 +7065,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7785,7 +7082,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7822,7 +7119,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -7846,7 +7143,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7861,7 +7158,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7877,8 +7174,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7915,7 +7212,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -7939,7 +7236,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7954,7 +7251,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7971,6 +7268,14 @@ Method Details
},
},
},
+ "balance": { # The card's monetary balance.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
"barcode": { # The barcode type and value.
"alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
@@ -7993,20 +7298,302 @@ Method Details
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
+ "cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
- "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
- "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
- "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
- },
- "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
- "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
- "firstBottomDetail": { # Optional information to display below the barcode.
- "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
@@ -8214,63 +7801,3200 @@ Method Details
},
],
},
- },
- },
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "discoverableProgram": { # Information about how a class may be discovered and instantiated from within the Android Pay app. This is done by searching for a loyalty or gift card program and scanning or manually entering. # Information about how the class may be discovered and instantiated from within the Google Pay app.
- "merchantSigninInfo": { # Information about the merchant hosted signin flow for a program. # Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
- "signinWebsite": { # The URL to direct the user to for the merchant's signin site.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedCardNumberLabel": { # Translated strings for the card_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedEventNumberLabel": { # Translated strings for the event_number_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedPinLabel": { # Translated strings for the pin_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
+ "eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "pin": "A String", # The card's PIN.
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+ "loyaltyClasses": [
+ {
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "discoverableProgram": { # Information about how a class may be discovered and instantiated from within the Android Pay app. This is done by searching for a loyalty or gift card program and scanning or manually entering. # Information about how the class may be discovered and instantiated from within the Google Pay app.
+ "merchantSigninInfo": { # Information about the merchant hosted signin flow for a program. # Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
+ "signinWebsite": { # The URL to direct the user to for the merchant's signin site.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "merchantSignupInfo": { # Information about the merchant hosted signup flow for a program. # Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
+ "signupSharedDatas": [ # User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.
+ "A String",
+ ],
+ "signupWebsite": { # The URL to direct the user to for the merchant's signup site.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "state": "A String", # Visibility state of the discoverable program.
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and one of object level `smartTapRedemptionLevel`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedAccountIdLabel": { # Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedAccountNameLabel": { # Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedProgramName": { # Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedRewardsTier": { # Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedRewardsTierLabel": { # Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedSecondaryRewardsTier": { # Translated strings for the secondary_rewards_tier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedSecondaryRewardsTierLabel": { # Translated strings for the secondary_rewards_tier_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
+ "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
+ "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
+ "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "loyaltyObjects": [
+ {
+ "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
+ "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
+ "updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
+ "url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
+ },
+ "classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
+ "cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
+ "firstBottomDetail": { # Optional information to display below the barcode.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
+ "fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "cardTemplateOverride": { # Override for the card view.
+ "cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
+ {
+ "oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "item": { # The item to be displayed in the row. This item will be automatically centered.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
+ "endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ "startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ },
+ ],
+ },
+ "detailsTemplateOverride": { # Override for the details view (beneath the card view).
+ "detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
+ {
+ "item": { # The item to be displayed in the details list.
+ "firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
+ "secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ ],
+ },
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "discoverableProgram": { # Information about how a class may be discovered and instantiated from within the Android Pay app. This is done by searching for a loyalty or gift card program and scanning or manually entering. # Information about how the class may be discovered and instantiated from within the Google Pay app.
+ "merchantSigninInfo": { # Information about the merchant hosted signin flow for a program. # Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
+ "signinWebsite": { # The URL to direct the user to for the merchant's signin site.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "merchantSignupInfo": { # Information about the merchant hosted signup flow for a program. # Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
+ "signupSharedDatas": [ # User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.
+ "A String",
+ ],
+ "signupWebsite": { # The URL to direct the user to for the merchant's signup site.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "state": "A String", # Visibility state of the discoverable program.
+ },
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and one of object level `smartTapRedemptionLevel`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ ],
+ },
+ "localizedAccountIdLabel": { # Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedAccountNameLabel": { # Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedProgramName": { # Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedRewardsTier": { # Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedRewardsTierLabel": { # Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedSecondaryRewardsTier": { # Translated strings for the secondary_rewards_tier.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedSecondaryRewardsTierLabel": { # Translated strings for the secondary_rewards_tier_label.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
+ "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
+ "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
+ "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
},
},
- "merchantSignupInfo": { # Information about the merchant hosted signup flow for a program. # Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
- "signupSharedDatas": [ # User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.
- "A String",
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
],
- "signupWebsite": { # The URL to direct the user to for the merchant's signup site.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
},
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "state": "A String", # Visibility state of the discoverable program.
},
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and one of object level `smartTapRedemptionLevel`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8307,12 +11031,34 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8327,14 +11073,33 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8349,145 +11114,103 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "localizedAccountIdLabel": { # Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyObject"`.
+ "linkedOfferIds": [ # A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
+ "A String",
+ ],
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "localizedAccountNameLabel": { # Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ "loyaltyPoints": { # The loyalty reward points label, balance, and type.
+ "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
+ "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
},
- "localizedProgramName": { # Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8502,37 +11225,72 @@ Method Details
},
],
},
- "localizedRewardsTier": { # Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedRewardsTierLabel": { # Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
],
},
- "localizedSecondaryRewardsTier": { # Translated strings for the secondary_rewards_tier.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8547,79 +11305,70 @@ Method Details
},
],
},
- "localizedSecondaryRewardsTierLabel": { # Translated strings for the secondary_rewards_tier_label.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
+ "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
+ "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ },
+ "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
+ ],
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8634,10 +11383,27 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+ "offerClasses": [
+ {
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8652,65 +11418,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
- "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
- "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
- "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8725,29 +11478,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8762,10 +11493,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8780,37 +11511,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8825,14 +11586,9 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8869,243 +11625,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyObject"`.
- "linkedOfferIds": [ # A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
- "A String",
- ],
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "loyaltyPoints": { # The loyalty reward points label, balance, and type.
- "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
- "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- },
- "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
- "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
- },
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
- },
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
- "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
- "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- },
- "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
- "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9120,7 +11664,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9136,22 +11680,7 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
},
- "version": "A String", # Deprecated
- },
- ],
- "offerClasses": [
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -9881,9 +12410,9 @@ Method Details
],
"offerObjects": [
{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9920,7 +12449,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9944,7 +12473,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9959,7 +12488,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9976,7 +12505,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10013,7 +12542,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10037,7 +12566,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10052,7 +12581,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10068,8 +12597,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10106,7 +12635,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10130,7 +12659,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10145,7 +12674,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10179,14 +12708,295 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -10779,9 +13589,278 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
+ "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
+ "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
+ "groupingInfo": { # Information that controls how passes are grouped together.
+ "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
+ "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
+ },
+ "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
+ "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerObject"`.
+ "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
+ "uris": [ # The list of URIs.
+ {
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10796,11 +13875,33 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
- "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
- "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10815,31 +13916,76 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ ],
},
+ "messageType": "A String", # The message type.
},
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
- "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10854,29 +14000,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10891,10 +14015,31 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+ "transitClasses": [
+ {
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10909,37 +14054,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- },
- "disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
- "groupingInfo": { # Information that controls how passes are grouped together.
- "groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
- "sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
- },
- "hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
- "hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10954,14 +14129,9 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10998,100 +14168,31 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerObject"`.
- "linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- ],
- },
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11106,7 +14207,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11121,61 +14222,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11190,7 +14300,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11203,29 +14313,10 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ ],
+ },
},
},
- "version": "A String", # Deprecated
- },
- ],
- "transitClasses": [
- {
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
- },
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -12195,9 +15286,9 @@ Method Details
"activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
"state": "A String",
},
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12234,7 +15325,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12258,7 +15349,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12273,7 +15364,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12290,7 +15381,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12327,7 +15418,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12351,7 +15442,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12366,7 +15457,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12382,8 +15473,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12420,7 +15511,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12444,7 +15535,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12459,7 +15550,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12505,6 +15596,287 @@ Method Details
"allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
},
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.loyaltyclass.html b/docs/dyn/walletobjects_v1.loyaltyclass.html
index e6938db90ba..d0df5987118 100644
--- a/docs/dyn/walletobjects_v1.loyaltyclass.html
+++ b/docs/dyn/walletobjects_v1.loyaltyclass.html
@@ -167,6 +167,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -979,6 +1260,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1779,6 +2341,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2578,6 +3421,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -3393,6 +4517,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4196,6 +5601,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4774,15 +6460,291 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
+ "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
+ "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
+ "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4797,7 +6759,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4812,68 +6774,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
- "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
- "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
- "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4888,7 +6852,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4904,29 +6868,69 @@ Method Details
],
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4941,29 +6945,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4978,23 +6960,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -5796,6 +7763,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6374,15 +8622,291 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
+ "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
+ "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
+ "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
+ "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6397,7 +8921,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6412,68 +8936,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "programName": "A String", # Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "rewardsTier": "A String", # The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
- "rewardsTierLabel": "A String", # The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
- "secondaryRewardsTier": "A String", # The secondary rewards tier, such as "Gold" or "Platinum."
- "secondaryRewardsTierLabel": "A String", # The secondary rewards tier label, such as "Rewards Tier."
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6488,7 +9014,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6504,29 +9030,69 @@ Method Details
],
},
},
- ],
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the loyalty card.
- "wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6541,29 +9107,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6578,23 +9122,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.loyaltyobject.html b/docs/dyn/walletobjects_v1.loyaltyobject.html
index 012c50059a7..db0bfc07d37 100644
--- a/docs/dyn/walletobjects_v1.loyaltyobject.html
+++ b/docs/dyn/walletobjects_v1.loyaltyobject.html
@@ -169,9 +169,9 @@ Method Details
"resource": { # The updated LoyaltyObject resource.
"accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
"accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -208,7 +208,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -232,7 +232,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -247,7 +247,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -264,7 +264,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -301,7 +301,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -325,7 +325,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -340,7 +340,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -356,8 +356,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -394,7 +394,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -418,7 +418,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -433,7 +433,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -477,6 +477,287 @@ Method Details
"accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1652,9 +1933,9 @@ Method Details
{
"accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
"accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1691,7 +1972,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1715,7 +1996,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1730,7 +2011,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1747,7 +2028,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1784,7 +2065,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1808,7 +2089,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1823,7 +2104,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1839,8 +2120,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1877,7 +2158,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1901,7 +2182,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1916,7 +2197,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1950,16 +2231,297 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2970,7 +3532,238 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
+ "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
+ "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ },
+ "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts an loyalty object with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
+ "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2985,89 +3778,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
- "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
- "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- },
- "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
- "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3082,7 +3856,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3098,34 +3872,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an loyalty object with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
- "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3162,7 +3910,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3186,7 +3934,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3199,27 +3962,116 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3234,10 +4086,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3252,67 +4104,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3327,10 +4179,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3345,92 +4197,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4593,9 +5436,9 @@ Method Details
{
"accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
"accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4632,7 +5475,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4656,7 +5499,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4671,7 +5514,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4688,7 +5531,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4725,7 +5568,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4749,7 +5592,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4764,7 +5607,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4780,8 +5623,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4818,7 +5661,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4842,7 +5685,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4857,7 +5700,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4891,16 +5734,297 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6079,9 +7203,9 @@ Method Details
{
"accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
"accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6118,7 +7242,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6142,7 +7266,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6157,7 +7281,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6174,7 +7298,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6211,7 +7335,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6235,7 +7359,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6250,7 +7374,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6266,8 +7390,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6304,7 +7428,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6328,7 +7452,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6343,7 +7467,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6377,16 +7501,297 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -7414,64 +8819,261 @@ Method Details
},
"messageType": "A String", # The message type.
},
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
+ "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
+ "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ },
+ "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+}
+
+
+
+ modifylinkedofferobjects(resourceId, body=None, x__xgafv=None)
+ Modifies linked offer objects for the loyalty object with the given ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "linkedOfferObjectIds": { # The linked offer object ids to add or remove from the object.
+ "addLinkedOfferObjectIds": [ # The linked offer object ids to add to the object.
+ "A String",
+ ],
+ "removeLinkedOfferObjectIds": [ # The linked offer object ids to remove from the object.
+ "A String",
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
+ "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
- },
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ ],
},
- "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
- "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
- "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- },
- "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
- "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7486,15 +9088,10 @@ Method Details
},
],
},
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7509,7 +9106,16 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7524,57 +9130,42 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "version": "A String", # Deprecated
},
- ],
-}
-
-
-
- modifylinkedofferobjects(resourceId, body=None, x__xgafv=None)
- Modifies linked offer objects for the loyalty object with the given ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "linkedOfferObjectIds": { # The linked offer object ids to add or remove from the object.
- "addLinkedOfferObjectIds": [ # The linked offer object ids to add to the object.
- "A String",
- ],
- "removeLinkedOfferObjectIds": [ # The linked offer object ids to remove from the object.
- "A String",
- ],
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
- "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7611,7 +9202,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -7635,7 +9226,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7648,27 +9254,116 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7683,10 +9378,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7701,67 +9396,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7776,10 +9471,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7794,92 +9489,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -9044,9 +10730,9 @@ Method Details
{
"accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
"accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9083,7 +10769,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9107,7 +10793,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9122,7 +10808,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9139,7 +10825,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9176,7 +10862,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9200,7 +10886,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9215,7 +10901,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9231,8 +10917,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9269,7 +10955,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9293,7 +10979,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9308,7 +10994,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9342,16 +11028,297 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -10362,7 +12329,237 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
+ "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
+ "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ },
+ "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
+ "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10377,89 +12574,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
- "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
- "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- },
- "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
- "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10474,7 +12652,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10490,33 +12668,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
- "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10553,7 +12706,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10577,7 +12730,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10590,27 +12758,116 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10625,10 +12882,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10643,67 +12900,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10718,10 +12975,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10736,92 +12993,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -11986,9 +14234,9 @@ Method Details
{
"accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
"accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12025,7 +14273,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12049,7 +14297,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12064,7 +14312,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12081,7 +14329,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12118,7 +14366,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12142,7 +14390,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12157,7 +14405,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12173,8 +14421,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12211,7 +14459,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12235,7 +14483,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12250,7 +14498,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12284,16 +14532,297 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -13304,7 +15833,237 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
+ "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
+ "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
+ "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
+ },
+ "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
+ },
+ "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
+ "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13319,89 +16078,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
- "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`.
- "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "int": 42, # The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "money": { # The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- "currencyCode": "A String", # The currency code, such as "USD" or "EUR."
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
- "micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
- },
- "string": "A String", # The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
- },
- "label": "A String", # The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
- "localizedLabel": { # Translated strings for the label. Recommended maximum length is 9 characters.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13416,7 +16156,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13432,33 +16172,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "accountId": "A String", # The loyalty account identifier. Recommended maximum length is 20 characters.
- "accountName": "A String", # The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -13495,7 +16210,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -13519,7 +16234,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13532,27 +16262,116 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13567,10 +16386,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13585,67 +16404,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13660,10 +16479,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -13678,92 +16497,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "accountIdLabel": "A String", # The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "accountNameLabel": "A String", # The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.offerclass.html b/docs/dyn/walletobjects_v1.offerclass.html
index 5afb13201cb..a373cfd5449 100644
--- a/docs/dyn/walletobjects_v1.offerclass.html
+++ b/docs/dyn/walletobjects_v1.offerclass.html
@@ -165,6 +165,287 @@ Method Details
{
"resource": { # The updated OfferClass resource.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -915,6 +1196,287 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1434,15 +1996,289 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
+ "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "shortTitle": "A String", # A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
+ "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
+ "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts an offer class with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1457,7 +2293,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1472,44 +2308,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
- "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "shortTitle": "A String", # A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1524,29 +2386,7 @@ Method Details
},
],
},
- },
- ],
- "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
- "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1561,68 +2401,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
- "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1637,22 +2494,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an offer class with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2172,15 +3015,288 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
+ "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "shortTitle": "A String", # A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
+ "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
+ "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2195,7 +3311,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2210,44 +3326,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
- "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "shortTitle": "A String", # A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2262,29 +3404,7 @@ Method Details
},
],
},
- },
- ],
- "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
- "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2299,31 +3419,70 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
- "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2337,30 +3496,8 @@ Method Details
"value": "A String", # The UTF-8 encoded translated string.
},
],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2375,21 +3512,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -3143,6 +4267,287 @@ Method Details
"resources": [ # Resources corresponding to the list request.
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -3884,6 +5289,287 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4621,6 +6307,287 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -5360,6 +7327,287 @@ Method Details
{
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -5879,15 +8127,288 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
+ "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "shortTitle": "A String", # A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
+ "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
+ "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5902,7 +8423,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5917,44 +8438,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
- "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "shortTitle": "A String", # A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5969,29 +8516,7 @@ Method Details
},
],
},
- },
- ],
- "title": "A String", # Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
- "titleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The title image of the offer. This image is displayed in both the details and list views of the app.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6006,31 +8531,70 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the offer.
- "wideTitleImage": { # Wrapping type for Google hosted images. Next ID: 7 # The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6045,29 +8609,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6082,21 +8624,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.offerobject.html b/docs/dyn/walletobjects_v1.offerobject.html
index 0d875935d63..0805850c74c 100644
--- a/docs/dyn/walletobjects_v1.offerobject.html
+++ b/docs/dyn/walletobjects_v1.offerobject.html
@@ -164,9 +164,9 @@ Method Details
{
"resource": { # The updated OfferObject resource.
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -203,7 +203,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -227,7 +227,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -242,7 +242,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -259,7 +259,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -296,7 +296,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -320,7 +320,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -335,7 +335,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -351,8 +351,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -389,7 +389,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -413,7 +413,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -428,7 +428,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -470,6 +470,287 @@ Method Details
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1464,69 +1745,162 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the offer object with the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ ],
},
},
- "version": "A String", # Deprecated
- },
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the offer object with the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1563,7 +1937,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1587,7 +1961,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1602,7 +1976,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1618,8 +1992,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1656,7 +2030,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -1680,7 +2054,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1695,25 +2069,220 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1728,10 +2297,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1746,90 +2315,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2796,29 +3358,146 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts an offer object with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2833,7 +3512,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2849,32 +3528,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an offer object with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2911,7 +3566,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2935,7 +3590,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2950,7 +3605,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2966,8 +3621,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -3004,7 +3659,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -3028,7 +3683,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3041,27 +3711,207 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3076,10 +3926,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -3094,90 +3944,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4153,20 +4996,136 @@ Method Details
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4181,7 +5140,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4197,31 +5156,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4258,7 +5194,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4282,7 +5218,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4297,7 +5233,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4313,8 +5249,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4351,7 +5287,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4375,7 +5311,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4390,7 +5326,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4406,9 +5342,96 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4423,10 +5446,118 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4441,90 +5572,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -5526,65 +6650,158 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ list(classId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all offer objects for a given issuer ID.
+
+Args:
+ classId: string, The ID of the class whose objects will be listed.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- list(classId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all offer objects for a given issuer ID.
-
-Args:
- classId: string, The ID of the class whose objects will be listed.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5621,7 +6838,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -5645,7 +6862,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5660,7 +6877,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5676,8 +6893,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5711,67 +6928,262 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5786,10 +7198,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5804,90 +7216,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6891,7 +8296,94 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the offer object referenced by the given object ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6906,36 +8398,42 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "version": "A String", # Deprecated
},
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the offer object referenced by the given object ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6972,7 +8470,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6996,7 +8494,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7011,7 +8509,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7027,8 +8525,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7065,7 +8563,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -7089,7 +8587,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7102,27 +8615,207 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7137,10 +8830,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7155,90 +8848,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -8205,29 +9891,145 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8242,7 +10044,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8258,31 +10060,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8319,7 +10098,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -8343,7 +10122,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8358,7 +10137,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8374,8 +10153,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8412,7 +10191,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -8436,7 +10215,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8449,27 +10243,207 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8484,10 +10458,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8502,90 +10476,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -9589,7 +11556,125 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the offer object referenced by the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9605,33 +11690,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the offer object referenced by the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9668,7 +11728,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9692,7 +11752,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9707,7 +11767,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9723,8 +11783,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -9761,7 +11821,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -9785,7 +11845,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9800,7 +11860,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9816,9 +11876,96 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9833,10 +11980,25 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9851,16 +12013,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -9873,68 +12104,85 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -10831,15 +13079,215 @@ Method Details
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
+ "nfcConstraint": [ # The NFC constraints for the pass.
+ "A String",
+ ],
+ "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
+ },
+ "rotatingBarcode": { # The rotating barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
+ "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
+ "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
+ "values": [ # Required. The values to encode in the barcode. At least one value is required.
+ "A String",
+ ],
+ },
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
+ "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
+ "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
+ { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
+ "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
+ "valueLength": 42, # The length of the TOTP value in decimal digits.
+ },
+ ],
+ "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
+ },
+ "type": "A String", # The type of this barcode.
+ "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
+ },
+ "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
+ "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10854,7 +13302,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10869,61 +13317,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
- },
- ],
- "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
- "nfcConstraint": [ # The NFC constraints for the pass.
- "A String",
- ],
- "screenshotEligibility": "A String", # The screenshot eligibility for the pass.
- },
- "rotatingBarcode": { # The rotating barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
- "periodMillis": "A String", # Required. The amount of time each barcode is valid for.
- "startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
- "values": [ # Required. The values to encode in the barcode. At least one value is required.
- "A String",
- ],
},
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
- "algorithm": "A String", # The TOTP algorithm used to generate the OTP.
- "parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
- { # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
- "key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
- "valueLength": 42, # The length of the TOTP value in decimal digits.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
- },
- "type": "A String", # The type of this barcode.
- "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
- },
- "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10938,7 +13395,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10954,31 +13411,8 @@ Method Details
],
},
},
- ],
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -11015,7 +13449,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -11039,7 +13473,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11052,27 +13501,114 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11087,10 +13623,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11105,67 +13641,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11180,10 +13716,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -11198,90 +13734,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
+ },
},
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.transitclass.html b/docs/dyn/walletobjects_v1.transitclass.html
index 2229931f3b5..4e4f2ffa23a 100644
--- a/docs/dyn/walletobjects_v1.transitclass.html
+++ b/docs/dyn/walletobjects_v1.transitclass.html
@@ -169,6 +169,287 @@ Method Details
"allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
},
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -862,14 +1143,165 @@ Method Details
},
],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
+ },
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "transitOperatorName": { # The name of the transit operator.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
+ "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -906,22 +1338,26 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -936,7 +1372,29 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -951,26 +1409,42 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the transit class with the given class ID.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -985,7 +1459,85 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1000,28 +1552,67 @@ Method Details
},
],
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- ],
- "transitOperatorName": { # The name of the transit operator.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
- "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1036,10 +1627,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1054,11 +1645,52 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- },
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1073,29 +1705,7 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1110,56 +1720,8 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
},
},
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the transit class with the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
- },
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -1348,38 +1910,203 @@ Method Details
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customCarriageLabel": { # A custom label to use for the carriage value (`transitObject.ticketLeg.carriage`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customCoachLabel": { # A custom label to use for the coach value (`transitObject.ticketLeg.ticketSeat.coach`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customConcessionCategoryLabel": { # A custom label to use for the transit concession category value (`transitObject.concessionCategory`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`transitObject.purchaseDetails.confirmationCode`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customDiscountMessageLabel": { # A custom label to use for the transit discount message value (`transitObject.purchaseDetails.ticketCost.discountMessage`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customFareClassLabel": { # A custom label to use for the fare class value (`transitObject.ticketLeg.ticketSeat.fareClass`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customFareNameLabel": { # A custom label to use for the transit fare name value (`transitObject.ticketLeg.fareName`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customOtherRestrictionsLabel": { # A custom label to use for the other restrictions value (`transitObject.ticketRestrictions.otherRestrictions`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "customPlatformLabel": { # A custom label to use for the boarding platform value (`transitObject.ticketLeg.platform`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "customPurchaseFaceValueLabel": { # A custom label to use for the purchase face value (`transitObject.purchaseDetails.ticketCost.faceValue`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "customPurchasePriceLabel": { # A custom label to use for the purchase price value (`transitObject.purchaseDetails.ticketCost.purchasePrice`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customCarriageLabel": { # A custom label to use for the carriage value (`transitObject.ticketLeg.carriage`).
+ "customPurchaseReceiptNumberLabel": { # A custom label to use for the purchase receipt number value (`transitObject.purchaseDetails.purchaseReceiptNumber`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1394,7 +2121,7 @@ Method Details
},
],
},
- "customCoachLabel": { # A custom label to use for the coach value (`transitObject.ticketLeg.ticketSeat.coach`).
+ "customRouteRestrictionsDetailsLabel": { # A custom label to use for the route restrictions details value (`transitObject.ticketRestrictions.routeRestrictionsDetails`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1409,7 +2136,7 @@ Method Details
},
],
},
- "customConcessionCategoryLabel": { # A custom label to use for the transit concession category value (`transitObject.concessionCategory`).
+ "customRouteRestrictionsLabel": { # A custom label to use for the route restrictions value (`transitObject.ticketRestrictions.routeRestrictions`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1424,7 +2151,7 @@ Method Details
},
],
},
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`transitObject.purchaseDetails.confirmationCode`).
+ "customSeatLabel": { # A custom label to use for the seat location value (`transitObject.ticketLeg.ticketSeat.seat`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1439,7 +2166,7 @@ Method Details
},
],
},
- "customDiscountMessageLabel": { # A custom label to use for the transit discount message value (`transitObject.purchaseDetails.ticketCost.discountMessage`).
+ "customTicketNumberLabel": { # A custom label to use for the ticket number value (`transitObject.ticketNumber`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1454,7 +2181,7 @@ Method Details
},
],
},
- "customFareClassLabel": { # A custom label to use for the fare class value (`transitObject.ticketLeg.ticketSeat.fareClass`).
+ "customTimeRestrictionsLabel": { # A custom label to use for the time restrictions details value (`transitObject.ticketRestrictions.timeRestrictions`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1469,7 +2196,22 @@ Method Details
},
],
},
- "customFareNameLabel": { # A custom label to use for the transit fare name value (`transitObject.ticketLeg.fareName`).
+ "customTransitTerminusNameLabel": { # A custom label to use for the transit terminus name value (`transitObject.ticketLeg.transitTerminusName`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customZoneLabel": { # A custom label to use for the boarding zone value (`transitObject.ticketLeg.zone`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1484,22 +2226,181 @@ Method Details
},
],
},
- "customOtherRestrictionsLabel": { # A custom label to use for the other restrictions value (`transitObject.ticketRestrictions.otherRestrictions`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "enableSingleLegItinerary": True or False, # Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
- "customPlatformLabel": { # A custom label to use for the boarding platform value (`transitObject.ticketLeg.platform`).
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1514,142 +2415,147 @@ Method Details
},
],
},
- "customPurchaseFaceValueLabel": { # A custom label to use for the purchase face value (`transitObject.purchaseDetails.ticketCost.faceValue`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "customPurchasePriceLabel": { # A custom label to use for the purchase price value (`transitObject.purchaseDetails.ticketCost.purchasePrice`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customPurchaseReceiptNumberLabel": { # A custom label to use for the purchase receipt number value (`transitObject.purchaseDetails.purchaseReceiptNumber`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "customRouteRestrictionsDetailsLabel": { # A custom label to use for the route restrictions details value (`transitObject.ticketRestrictions.routeRestrictionsDetails`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
},
- ],
- },
- "customRouteRestrictionsLabel": { # A custom label to use for the route restrictions value (`transitObject.ticketRestrictions.routeRestrictions`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat location value (`transitObject.ticketLeg.ticketSeat.seat`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customTicketNumberLabel": { # A custom label to use for the ticket number value (`transitObject.ticketNumber`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "messageType": "A String", # The message type.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
},
- "customTimeRestrictionsLabel": { # A custom label to use for the time restrictions details value (`transitObject.ticketRestrictions.timeRestrictions`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customTransitTerminusNameLabel": { # A custom label to use for the transit terminus name value (`transitObject.ticketLeg.transitTerminusName`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customZoneLabel": { # A custom label to use for the boarding zone value (`transitObject.ticketLeg.zone`).
+ ],
+ "transitOperatorName": { # The name of the transit operator.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1664,9 +2570,10 @@ Method Details
},
],
},
- "enableSingleLegItinerary": True or False, # Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
+ "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1703,12 +2610,8 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1723,144 +2626,28 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
},
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -1897,22 +2684,87 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts a transit class with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1927,7 +2779,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1942,41 +2794,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -1991,46 +2872,7 @@ Method Details
},
],
},
- },
- ],
- "transitOperatorName": { # The name of the transit operator.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
- "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2045,29 +2887,70 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2082,29 +2965,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2118,27 +2979,9 @@ Method Details
"value": "A String", # The UTF-8 encoded translated string.
},
],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts a transit class with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -3116,7 +3959,288 @@ Method Details
"activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
"allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4074,43 +5198,324 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
-}
-
-
-
- list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all transit classes for a given issuer ID.
-
-Args:
- issuerId: string, The ID of the issuer authorized to list classes.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- {
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+
+
+ list(issuerId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all transit classes for a given issuer ID.
+
+Args:
+ issuerId: string, The ID of the issuer authorized to list classes.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ {
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4810,8 +6215,196 @@ Method Details
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "messageType": "A String", # The message type.
+ },
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
+ },
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "transitOperatorName": { # The name of the transit operator.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
+ "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4848,37 +6441,26 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedHeader": { # Translated strings for the message header.
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4893,26 +6475,51 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
},
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the transit class referenced by the given class ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4927,7 +6534,16 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4942,9 +6558,10 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "transitOperatorName": { # The name of the transit operator.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4959,10 +6576,24 @@ Method Details
},
],
},
- "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
- "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4999,26 +6630,13 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -5033,10 +6651,42 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -5073,26 +6723,62 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the transit class referenced by the given class ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6070,7 +7756,288 @@ Method Details
"activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
"allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6956,29 +8923,273 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the transit class referenced by the given class ID.
+
+Args:
+ resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6993,29 +9204,85 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7030,27 +9297,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the transit class referenced by the given class ID.
-
-Args:
- resourceId: string, The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
- },
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -7239,38 +9487,203 @@ Method Details
},
],
},
- "listTemplateOverride": { # Override for the passes list view.
- "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
- "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
- },
- "transitOption": "A String",
+ "listTemplateOverride": { # Override for the passes list view.
+ "firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
+ "fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "transitOption": "A String",
+ },
+ "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
+ "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
+ { # Reference definition to use with field overrides.
+ "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
+ "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
+ },
+ ],
+ },
+ },
+ },
+ "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
+ "customCarriageLabel": { # A custom label to use for the carriage value (`transitObject.ticketLeg.carriage`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customCoachLabel": { # A custom label to use for the coach value (`transitObject.ticketLeg.ticketSeat.coach`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customConcessionCategoryLabel": { # A custom label to use for the transit concession category value (`transitObject.concessionCategory`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`transitObject.purchaseDetails.confirmationCode`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customDiscountMessageLabel": { # A custom label to use for the transit discount message value (`transitObject.purchaseDetails.ticketCost.discountMessage`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customFareClassLabel": { # A custom label to use for the fare class value (`transitObject.ticketLeg.ticketSeat.fareClass`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customFareNameLabel": { # A custom label to use for the transit fare name value (`transitObject.ticketLeg.fareName`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customOtherRestrictionsLabel": { # A custom label to use for the other restrictions value (`transitObject.ticketRestrictions.otherRestrictions`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "customPlatformLabel": { # A custom label to use for the boarding platform value (`transitObject.ticketLeg.platform`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
- "fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
- { # Reference definition to use with field overrides.
- "dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
- "fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
- },
- ],
+ ],
+ },
+ "customPurchaseFaceValueLabel": { # A custom label to use for the purchase face value (`transitObject.purchaseDetails.ticketCost.faceValue`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ ],
+ },
+ "customPurchasePriceLabel": { # A custom label to use for the purchase price value (`transitObject.purchaseDetails.ticketCost.purchasePrice`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
- "customCarriageLabel": { # A custom label to use for the carriage value (`transitObject.ticketLeg.carriage`).
+ "customPurchaseReceiptNumberLabel": { # A custom label to use for the purchase receipt number value (`transitObject.purchaseDetails.purchaseReceiptNumber`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7285,7 +9698,7 @@ Method Details
},
],
},
- "customCoachLabel": { # A custom label to use for the coach value (`transitObject.ticketLeg.ticketSeat.coach`).
+ "customRouteRestrictionsDetailsLabel": { # A custom label to use for the route restrictions details value (`transitObject.ticketRestrictions.routeRestrictionsDetails`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7300,7 +9713,7 @@ Method Details
},
],
},
- "customConcessionCategoryLabel": { # A custom label to use for the transit concession category value (`transitObject.concessionCategory`).
+ "customRouteRestrictionsLabel": { # A custom label to use for the route restrictions value (`transitObject.ticketRestrictions.routeRestrictions`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7315,7 +9728,7 @@ Method Details
},
],
},
- "customConfirmationCodeLabel": { # A custom label to use for the confirmation code value (`transitObject.purchaseDetails.confirmationCode`).
+ "customSeatLabel": { # A custom label to use for the seat location value (`transitObject.ticketLeg.ticketSeat.seat`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7330,7 +9743,7 @@ Method Details
},
],
},
- "customDiscountMessageLabel": { # A custom label to use for the transit discount message value (`transitObject.purchaseDetails.ticketCost.discountMessage`).
+ "customTicketNumberLabel": { # A custom label to use for the ticket number value (`transitObject.ticketNumber`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7345,7 +9758,7 @@ Method Details
},
],
},
- "customFareClassLabel": { # A custom label to use for the fare class value (`transitObject.ticketLeg.ticketSeat.fareClass`).
+ "customTimeRestrictionsLabel": { # A custom label to use for the time restrictions details value (`transitObject.ticketRestrictions.timeRestrictions`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7360,7 +9773,22 @@ Method Details
},
],
},
- "customFareNameLabel": { # A custom label to use for the transit fare name value (`transitObject.ticketLeg.fareName`).
+ "customTransitTerminusNameLabel": { # A custom label to use for the transit terminus name value (`transitObject.ticketLeg.transitTerminusName`).
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "customZoneLabel": { # A custom label to use for the boarding zone value (`transitObject.ticketLeg.zone`).
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7375,22 +9803,181 @@ Method Details
},
],
},
- "customOtherRestrictionsLabel": { # A custom label to use for the other restrictions value (`transitObject.ticketRestrictions.otherRestrictions`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
+ "enableSingleLegItinerary": True or False, # Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
+ "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
+ "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
+ "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
+ {
+ "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
+ "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ },
+ ],
+ "infoModuleData": { # Deprecated. Use textModulesData instead.
+ "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
+ {
+ "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
+ { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
+ "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
+ },
+ ],
+ },
+ ],
+ "showLastUpdateTime": True or False,
+ },
+ "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
+ "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
+ "uris": [ # The list of URIs.
{
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
- "customPlatformLabel": { # A custom label to use for the boarding platform value (`transitObject.ticketLeg.platform`).
+ "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7405,142 +9992,147 @@ Method Details
},
],
},
- "customPurchaseFaceValueLabel": { # A custom label to use for the purchase face value (`transitObject.purchaseDetails.ticketCost.faceValue`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "locations": [ # Note: This field is currently not supported to trigger geo notifications.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
+ "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
+ "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "customPurchasePriceLabel": { # A custom label to use for the purchase price value (`transitObject.purchaseDetails.ticketCost.purchasePrice`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customPurchaseReceiptNumberLabel": { # A custom label to use for the purchase receipt number value (`transitObject.purchaseDetails.purchaseReceiptNumber`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "customRouteRestrictionsDetailsLabel": { # A custom label to use for the route restrictions details value (`transitObject.ticketRestrictions.routeRestrictionsDetails`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
+ { # A message that will be displayed with a Valuable
+ "body": "A String", # The message body.
+ "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
},
- ],
- },
- "customRouteRestrictionsLabel": { # A custom label to use for the route restrictions value (`transitObject.ticketRestrictions.routeRestrictions`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "header": "A String", # The message header.
+ "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
+ "localizedBody": { # Translated strings for the message body.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customSeatLabel": { # A custom label to use for the seat location value (`transitObject.ticketLeg.ticketSeat.seat`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "localizedHeader": { # Translated strings for the message header.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customTicketNumberLabel": { # A custom label to use for the ticket number value (`transitObject.ticketNumber`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "messageType": "A String", # The message type.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
+ "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
+ "A String",
+ ],
+ "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
+ "comments": "A String",
},
- "customTimeRestrictionsLabel": { # A custom label to use for the time restrictions details value (`transitObject.ticketRestrictions.timeRestrictions`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
+ "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
+ "animationType": "A String", # Type of animation.
+ },
+ "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
+ { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
+ "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
+ "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "customTransitTerminusNameLabel": { # A custom label to use for the transit terminus name value (`transitObject.ticketLeg.transitTerminusName`).
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "customZoneLabel": { # A custom label to use for the boarding zone value (`transitObject.ticketLeg.zone`).
+ ],
+ "transitOperatorName": { # The name of the transit operator.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7555,9 +10147,10 @@ Method Details
},
],
},
- "enableSingleLegItinerary": True or False, # Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
- "enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
+ "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
+ "version": "A String", # Deprecated
+ "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
+ "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7594,12 +10187,8 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
- "homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7614,144 +10203,28 @@ Method Details
},
],
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- "id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
- "imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
- {
- "id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
- "mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of the image. URIs must have a scheme.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- },
- },
- ],
- "infoModuleData": { # Deprecated. Use textModulesData instead.
- "labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
- {
- "columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
- { # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
- "label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
- },
- ],
- },
- ],
- "showLastUpdateTime": True or False,
- },
- "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
- "uris": [ # The list of URIs.
- {
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ ],
},
- ],
- },
- "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "locations": [ # Note: This field is currently not supported to trigger geo notifications.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
- "latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
- "longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
- },
- ],
- "logo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
+ "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -7788,22 +10261,86 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
- { # A message that will be displayed with a Valuable
- "body": "A String", # The message body.
- "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "header": "A String", # The message header.
- "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
- "localizedBody": { # Translated strings for the message body.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7818,7 +10355,7 @@ Method Details
},
],
},
- "localizedHeader": { # Translated strings for the message header.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7833,41 +10370,70 @@ Method Details
},
],
},
- "messageType": "A String", # The message type.
},
- ],
- "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
- "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
- "A String",
- ],
- "review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
- "comments": "A String",
- },
- "reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
- "securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
- "animationType": "A String", # Type of animation.
- },
- "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
- { # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
- "body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
- "id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules.
- "localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7882,46 +10448,7 @@ Method Details
},
],
},
- },
- ],
- "transitOperatorName": { # The name of the transit operator.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "version": "A String", # Deprecated
- "viewUnlockRequirement": "A String", # View Unlock Requirement options for the transit ticket.
- "watermark": { # Wrapping type for Google hosted images. Next ID: 7 # Watermark image to display on the user's device.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7936,29 +10463,70 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
- },
- "wideLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -7973,29 +10541,7 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
- "contentDescription": { # Description of the image used for accessibility.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8010,25 +10556,8 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
},
},
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
- },
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/walletobjects_v1.transitobject.html b/docs/dyn/walletobjects_v1.transitobject.html
index 4750adc1f01..74db20fccc1 100644
--- a/docs/dyn/walletobjects_v1.transitobject.html
+++ b/docs/dyn/walletobjects_v1.transitobject.html
@@ -167,9 +167,9 @@ Method Details
"activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
"state": "A String",
},
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -206,7 +206,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -230,7 +230,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -245,7 +245,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -262,7 +262,7 @@ Method Details
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -299,7 +299,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -323,7 +323,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -338,7 +338,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -354,8 +354,8 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -392,7 +392,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -416,7 +416,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -431,7 +431,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -477,6 +477,287 @@ Method Details
"allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
},
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -2132,24 +2413,158 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "routeRestrictions": { # Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "routeRestrictions": { # Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "timeRestrictions": { # Restrictions about times this ticket may be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(resourceId, x__xgafv=None)
+ Returns the transit object with the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
},
- "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2164,7 +2579,7 @@ Method Details
},
],
},
- "timeRestrictions": { # Restrictions about times this ticket may be used.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2180,49 +2595,8 @@ Method Details
],
},
},
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
- },
-}
-
-
-
- close()
- Close httplib2 connections.
-
-
-
- get(resourceId, x__xgafv=None)
- Returns the transit object with the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2259,7 +2633,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2283,7 +2657,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2298,7 +2672,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2314,8 +2688,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -2352,7 +2726,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -2376,7 +2750,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2391,7 +2765,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2407,9 +2781,208 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2424,10 +2997,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -2442,94 +3015,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -4200,70 +4762,163 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "timeRestrictions": { # Restrictions about times this ticket may be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ insert(body=None, x__xgafv=None)
+ Inserts an transit object with the given ID and properties.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "timeRestrictions": { # Restrictions about times this ticket may be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- "version": "A String", # Deprecated
-}
-
-
-
- insert(body=None, x__xgafv=None)
- Inserts an transit object with the given ID and properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4300,7 +4955,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4324,7 +4979,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4339,7 +4994,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4355,8 +5010,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -4393,7 +5048,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -4417,7 +5072,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4432,7 +5087,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4448,9 +5103,208 @@ Method Details
],
},
},
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4465,10 +5319,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -4483,94 +5337,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -6241,69 +7084,162 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "timeRestrictions": { # Restrictions about times this ticket may be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "timeRestrictions": { # Restrictions about times this ticket may be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6340,7 +7276,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6364,7 +7300,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6379,7 +7315,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6395,8 +7331,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -6433,7 +7369,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -6457,7 +7393,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6470,27 +7421,211 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6505,10 +7640,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -6523,94 +7658,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -8311,55 +9435,148 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- },
- "version": "A String", # Deprecated
-}
-
-
-
- list(classId=None, maxResults=None, token=None, x__xgafv=None)
- Returns a list of all transit objects for a given issuer ID.
-
-Args:
- classId: string, The ID of the class whose objects will be listed.
- maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
- token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "pagination": { # Pagination of the response.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
- "nextPageToken": "A String", # Page token to send to fetch the next page.
- "resultsPerPage": 42, # Number of results returned in this page.
- },
- "resources": [ # Resources corresponding to the list request.
- {
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ list(classId=None, maxResults=None, token=None, x__xgafv=None)
+ Returns a list of all transit objects for a given issuer ID.
+
+Args:
+ classId: string, The ID of the class whose objects will be listed.
+ maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
+ token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "pagination": { # Pagination of the response.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
+ "nextPageToken": "A String", # Page token to send to fetch the next page.
+ "resultsPerPage": 42, # Number of results returned in this page.
+ },
+ "resources": [ # Resources corresponding to the list request.
+ {
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8396,7 +9613,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -8420,7 +9637,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8435,7 +9652,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8451,8 +9668,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -8489,7 +9706,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -8513,7 +9730,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8528,7 +9745,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8541,12 +9758,211 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8561,10 +9977,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -8579,94 +9995,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -10339,71 +11744,164 @@ Method Details
},
],
},
- "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "timeRestrictions": { # Restrictions about times this ticket may be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+ },
+ ],
+}
+
+
+
+ patch(resourceId, body=None, x__xgafv=None)
+ Updates the transit object referenced by the given object ID. This method supports patch semantics.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
},
- "timeRestrictions": { # Restrictions about times this ticket may be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
+ ],
},
- "version": "A String", # Deprecated
},
- ],
-}
-
-
-
- patch(resourceId, body=None, x__xgafv=None)
- Updates the transit object referenced by the given object ID. This method supports patch semantics.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10440,7 +11938,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10464,7 +11962,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10479,7 +11977,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10495,8 +11993,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -10533,7 +12031,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -10557,7 +12055,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10572,25 +12070,224 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10605,10 +12302,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -10623,94 +12320,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -12396,54 +14082,147 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "timeRestrictions": { # Restrictions about times this ticket may be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ "timeRestrictions": { # Restrictions about times this ticket may be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12480,7 +14259,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12504,7 +14283,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12519,7 +14298,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12535,8 +14314,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -12573,7 +14352,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -12597,7 +14376,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12610,27 +14404,211 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12645,10 +14623,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -12663,94 +14641,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -14444,48 +16411,141 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+
+
+ update(resourceId, body=None, x__xgafv=None)
+ Updates the transit object referenced by the given object ID.
+
+Args:
+ resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- "version": "A String", # Deprecated
-}
-
-
-
- update(resourceId, body=None, x__xgafv=None)
- Updates the transit object referenced by the given object ID.
-
-Args:
- resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -14522,7 +16582,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -14546,7 +16606,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -14561,7 +16621,7 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -14577,8 +16637,8 @@ Method Details
],
},
},
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -14615,7 +16675,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -14639,7 +16699,7 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -14654,25 +16714,224 @@ Method Details
},
],
},
- "title": { # String to be displayed in the title of the App Link Module Required
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -14687,10 +16946,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -14705,94 +16964,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
@@ -16115,15 +18363,135 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ ],
+ },
+ },
+ ],
+ "ticketLeg": { # A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the `ticketLegs` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
+ "arrivalDateTime": "A String", # The date/time of arrival. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the destination station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "carriage": "A String", # The train or ship name/number that the passsenger needs to board.
+ "departureDateTime": "A String", # The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the origin station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "destinationName": { # The destination name.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "destinationStationCode": "A String", # The destination station code.
+ "fareName": { # Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "originName": { # The name of the origin station. This is required if `desinationName` is present or if `originStationCode` is not present.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "originStationCode": "A String", # The origin station code. This is required if `destinationStationCode` is present or if `originName` is not present.
+ "platform": "A String", # The platform or gate where the passenger can board the carriage.
+ "ticketSeat": { # The reserved seat for the passenger(s). If more than one seat is to be specified then use the `ticketSeats` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
+ "coach": "A String", # The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
+ "customFareClass": { # A custome fare class to be used if no `fareClass` applies. Both `fareClass` and `customFareClass` may not be set.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "fareClass": "A String", # The fare class of the ticketed seat.
+ "seat": "A String", # The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use `seatAssigment` instead.
+ "seatAssignment": { # The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in `seat`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketSeats": [ # The reserved seat for the passenger(s). If only one seat is to be specified then use the `ticketSeat` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
+ {
+ "coach": "A String", # The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
+ "customFareClass": { # A custome fare class to be used if no `fareClass` applies. Both `fareClass` and `customFareClass` may not be set.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "fareClass": "A String", # The fare class of the ticketed seat.
+ "seat": "A String", # The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use `seatAssigment` instead.
+ "seatAssignment": { # The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in `seat`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
},
- },
- ],
- "ticketLeg": { # A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the `ticketLegs` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
- "arrivalDateTime": "A String", # The date/time of arrival. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the destination station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "carriage": "A String", # The train or ship name/number that the passsenger needs to board.
- "departureDateTime": "A String", # The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the origin station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "destinationName": { # The destination name.
+ ],
+ "transitOperatorName": { # The name of the transit operator that is operating this leg of a trip.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16138,8 +18506,7 @@ Method Details
},
],
},
- "destinationStationCode": "A String", # The destination station code.
- "fareName": { # Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".
+ "transitTerminusName": { # Terminus station or destination of the train/bus/etc.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16154,26 +18521,30 @@ Method Details
},
],
},
- "originName": { # The name of the origin station. This is required if `desinationName` is present or if `originStationCode` is not present.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "zone": "A String", # The zone of boarding within the platform.
+ },
+ "ticketLegs": [ # Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the `ticketLeg` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
+ {
+ "arrivalDateTime": "A String", # The date/time of arrival. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the destination station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "carriage": "A String", # The train or ship name/number that the passsenger needs to board.
+ "departureDateTime": "A String", # The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the origin station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
+ "destinationName": { # The destination name.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "originStationCode": "A String", # The origin station code. This is required if `destinationStationCode` is present or if `originName` is not present.
- "platform": "A String", # The platform or gate where the passenger can board the carriage.
- "ticketSeat": { # The reserved seat for the passenger(s). If more than one seat is to be specified then use the `ticketSeats` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
- "coach": "A String", # The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
- "customFareClass": { # A custome fare class to be used if no `fareClass` applies. Both `fareClass` and `customFareClass` may not be set.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "destinationStationCode": "A String", # The destination station code.
+ "fareName": { # Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16188,9 +18559,7 @@ Method Details
},
],
},
- "fareClass": "A String", # The fare class of the ticketed seat.
- "seat": "A String", # The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use `seatAssigment` instead.
- "seatAssignment": { # The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in `seat`.
+ "originName": { # The name of the origin station. This is required if `desinationName` is present or if `originStationCode` is not present.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16205,9 +18574,9 @@ Method Details
},
],
},
- },
- "ticketSeats": [ # The reserved seat for the passenger(s). If only one seat is to be specified then use the `ticketSeat` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
- {
+ "originStationCode": "A String", # The origin station code. This is required if `destinationStationCode` is present or if `originName` is not present.
+ "platform": "A String", # The platform or gate where the passenger can board the carriage.
+ "ticketSeat": { # The reserved seat for the passenger(s). If more than one seat is to be specified then use the `ticketSeats` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
"coach": "A String", # The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
"customFareClass": { # A custome fare class to be used if no `fareClass` applies. Both `fareClass` and `customFareClass` may not be set.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16242,8 +18611,79 @@ Method Details
],
},
},
- ],
- "transitOperatorName": { # The name of the transit operator that is operating this leg of a trip.
+ "ticketSeats": [ # The reserved seat for the passenger(s). If only one seat is to be specified then use the `ticketSeat` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
+ {
+ "coach": "A String", # The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
+ "customFareClass": { # A custome fare class to be used if no `fareClass` applies. Both `fareClass` and `customFareClass` may not be set.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "fareClass": "A String", # The fare class of the ticketed seat.
+ "seat": "A String", # The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use `seatAssigment` instead.
+ "seatAssignment": { # The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in `seat`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ ],
+ "transitOperatorName": { # The name of the transit operator that is operating this leg of a trip.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "transitTerminusName": { # Terminus station or destination of the train/bus/etc.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "zone": "A String", # The zone of boarding within the platform.
+ },
+ ],
+ "ticketNumber": "A String", # The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
+ "ticketRestrictions": { # Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.
+ "otherRestrictions": { # Extra restrictions that don't fall under the "route" or "time" categories.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16258,7 +18698,7 @@ Method Details
},
],
},
- "transitTerminusName": { # Terminus station or destination of the train/bus/etc.
+ "routeRestrictions": { # Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only".
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16273,30 +18713,128 @@ Method Details
},
],
},
- "zone": "A String", # The zone of boarding within the platform.
- },
- "ticketLegs": [ # Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the `ticketLeg` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
- {
- "arrivalDateTime": "A String", # The date/time of arrival. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the destination station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "carriage": "A String", # The train or ship name/number that the passsenger needs to board.
- "departureDateTime": "A String", # The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the origin station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
- "destinationName": { # The destination name.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ ],
+ },
+ "timeRestrictions": { # Restrictions about times this ticket may be used.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ },
+ "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
+ "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
+ "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
+ "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
+ "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
+ "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
+ "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
+ },
+ },
+ "version": "A String", # Deprecated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
+ "state": "A String",
+ },
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "destinationStationCode": "A String", # The destination station code.
- "fareName": { # Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16311,7 +18849,7 @@ Method Details
},
],
},
- "originName": { # The name of the origin station. This is required if `desinationName` is present or if `originStationCode` is not present.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16326,28 +18864,10 @@ Method Details
},
],
},
- "originStationCode": "A String", # The origin station code. This is required if `destinationStationCode` is present or if `originName` is not present.
- "platform": "A String", # The platform or gate where the passenger can board the carriage.
- "ticketSeat": { # The reserved seat for the passenger(s). If more than one seat is to be specified then use the `ticketSeats` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
- "coach": "A String", # The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
- "customFareClass": { # A custome fare class to be used if no `fareClass` applies. Both `fareClass` and `customFareClass` may not be set.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "fareClass": "A String", # The fare class of the ticketed seat.
- "seat": "A String", # The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use `seatAssigment` instead.
- "seatAssignment": { # The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in `seat`.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16362,11 +18882,10 @@ Method Details
},
],
},
- },
- "ticketSeats": [ # The reserved seat for the passenger(s). If only one seat is to be specified then use the `ticketSeat` field instead. Both `ticketSeat` and `ticketSeats` may not be set.
- {
- "coach": "A String", # The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
- "customFareClass": { # A custome fare class to be used if no `fareClass` applies. Both `fareClass` and `customFareClass` may not be set.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16381,9 +18900,16 @@ Method Details
},
],
},
- "fareClass": "A String", # The fare class of the ticketed seat.
- "seat": "A String", # The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use `seatAssigment` instead.
- "seatAssignment": { # The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in `seat`.
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16398,9 +18924,10 @@ Method Details
},
],
},
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- "transitOperatorName": { # The name of the transit operator that is operating this leg of a trip.
+ },
+ "description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16415,7 +18942,7 @@ Method Details
},
],
},
- "transitTerminusName": { # Terminus station or destination of the train/bus/etc.
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16430,102 +18957,9 @@ Method Details
},
],
},
- "zone": "A String", # The zone of boarding within the platform.
- },
- ],
- "ticketNumber": "A String", # The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
- "ticketRestrictions": { # Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.
- "otherRestrictions": { # Extra restrictions that don't fall under the "route" or "time" categories.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "routeRestrictions": { # Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only".
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "routeRestrictionsDetails": { # More details about the above `routeRestrictions`.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- "timeRestrictions": { # Restrictions about times this ticket may be used.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- ],
- },
- },
- "ticketStatus": "A String", # The status of the ticket. For states which affect display, use the `state` field instead.
- "tripId": "A String", # This id is used to group tickets together if the user has saved multiple tickets for the same trip.
- "tripType": "A String", # Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
- "validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
- "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
- "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
- "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
- },
- "version": "A String", # Deprecated
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "activationStatus": { # The activation status of the object. This field includes activation status if valuable supports activation. # The activation status for the object. Required if the class has `activationOptions` set.
- "state": "A String",
- },
- "appLinkData": { # Optional information about the partner app link.
- "androidAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
@@ -16562,7 +18996,7 @@ Method Details
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
@@ -16586,7 +19020,22 @@ Method Details
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
- "description": { # String to be displayed in the description of the App Link Module Required
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16599,27 +19048,118 @@ Method Details
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ ],
+ },
+ },
+ },
+ "barcode": { # The barcode type and value.
+ "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
+ "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
+ "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "type": "A String", # The type of barcode.
+ "value": "A String", # The value encoded in the barcode.
+ },
+ "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
+ "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
+ "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
+ "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
+ "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
+ "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
+ "appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
+ "androidAppLinkInfo": { # Optional information about the partner app link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
+ },
+ },
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16634,10 +19174,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16652,67 +19192,67 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
- },
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- "webAppLinkInfo": { # Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
- "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional image to be displayed in the App Link Module
- "contentDescription": { # Description of the image used for accessibility.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16727,10 +19267,10 @@ Method Details
},
],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
- "sourceUri": { # The URI for the image.
- "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
- "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ },
+ "webAppLinkInfo": { # Optional information about the partner web link.
+ "appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
+ "contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
@@ -16745,94 +19285,83 @@ Method Details
},
],
},
- "uri": "A String", # The location of the image. URIs must have a scheme.
- },
- },
- "appTarget": { # Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.
- "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
- "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
- "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
- "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
- "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
+ "sourceUri": { # The URI for the image.
+ "description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
+ "localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of the image. URIs must have a scheme.
},
- "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
- },
- "description": { # String to be displayed in the description of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
+ "packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
+ "targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
+ "description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
+ "id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
+ "localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
+ },
+ "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
+ },
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "description": { # Deprecated. Description isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- "title": { # String to be displayed in the title of the App Link Module Required
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
+ "title": { # Deprecated. Title isn't supported in the app link module.
+ "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
- ],
- },
- },
- },
- "barcode": { # The barcode type and value.
- "alternateText": "A String", # An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
- "renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
- "showCodeText": { # Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
- "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
- },
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
- "translatedValues": [ # Contains the translations for the string.
- {
- "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
- "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
- "value": "A String", # The UTF-8 encoded translated string.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
+ "translatedValues": [ # Contains the translations for the string.
+ {
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
+ "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
+ "value": "A String", # The UTF-8 encoded translated string.
+ },
+ ],
},
- ],
- },
- "type": "A String", # The type of barcode.
- "value": "A String", # The value encoded in the barcode.
- },
- "classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
- "classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
- "activationOptions": { # ActivationOptions for the class # Activation options for an activatable ticket.
- "activationUrl": "A String", # HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
- "allowReactivation": True or False, # Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
+ },
},
- "allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
diff --git a/docs/dyn/workflows_v1.projects.locations.workflows.html b/docs/dyn/workflows_v1.projects.locations.workflows.html
index c41fd4274ac..ee78403bc11 100644
--- a/docs/dyn/workflows_v1.projects.locations.workflows.html
+++ b/docs/dyn/workflows_v1.projects.locations.workflows.html
@@ -117,9 +117,16 @@ Method Details
The object takes the form of:
{ # Workflow program to be executed by Workflows.
+ "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
+ "allKmsKeysVersions": [ # Output only. A list of all KMS crypto keys versions used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
"callLogLevel": "A String", # Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
"createTime": "A String", # Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
+ "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
"a_key": "A String",
@@ -221,9 +228,16 @@ Method Details
An object of the form:
{ # Workflow program to be executed by Workflows.
+ "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
+ "allKmsKeysVersions": [ # Output only. A list of all KMS crypto keys versions used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
"callLogLevel": "A String", # Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
"createTime": "A String", # Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
+ "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
"a_key": "A String",
@@ -270,9 +284,16 @@ Method Details
],
"workflows": [ # The workflows that match the request.
{ # Workflow program to be executed by Workflows.
+ "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
+ "allKmsKeysVersions": [ # Output only. A list of all KMS crypto keys versions used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
"callLogLevel": "A String", # Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
"createTime": "A String", # Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
+ "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
"a_key": "A String",
@@ -316,9 +337,16 @@ Method Details
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"workflows": [ # The revisions of the workflow, ordered in reverse chronological order.
{ # Workflow program to be executed by Workflows.
+ "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
+ "allKmsKeysVersions": [ # Output only. A list of all KMS crypto keys versions used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
"callLogLevel": "A String", # Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
"createTime": "A String", # Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
+ "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
"a_key": "A String",
@@ -380,9 +408,16 @@ Method Details
The object takes the form of:
{ # Workflow program to be executed by Workflows.
+ "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
+ "allKmsKeysVersions": [ # Output only. A list of all KMS crypto keys versions used to encrypt or decrpt the data associated with the workflow.
+ "A String",
+ ],
"callLogLevel": "A String", # Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
"createTime": "A String", # Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
+ "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
"a_key": "A String",
diff --git a/docs/dyn/youtube_v3.liveChatMessages.html b/docs/dyn/youtube_v3.liveChatMessages.html
index 6cda600874e..131b9c6f594 100644
--- a/docs/dyn/youtube_v3.liveChatMessages.html
+++ b/docs/dyn/youtube_v3.liveChatMessages.html
@@ -89,6 +89,9 @@ Instance Methods
Retrieves the next page of results.
+
+ transition(id=None, status=None, x__xgafv=None)
+Transition a durable chat event.
Method Details
close()
@@ -564,4 +567,120 @@ Method Details
+
+ transition(id=None, status=None, x__xgafv=None)
+ Transition a durable chat event.
+
+Args:
+ id: string, The ID that uniquely identify the chat message event to transition.
+ status: string, The status to which the chat event is going to transition.
+ Allowed values
+ statusUnspecified - Default unknown enum value.
+ closed - The durable chat event is over.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
+ "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
+ "channelId": "A String", # The YouTube channel ID.
+ "channelUrl": "A String", # The channel's URL.
+ "displayName": "A String", # The channel's display name.
+ "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+ "isChatOwner": True or False, # Whether the author is the owner of the live chat.
+ "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
+ "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ },
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
+ "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
+ "snippet": { # Next ID: 34 # The snippet object contains basic details about the message.
+ "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
+ "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
+ "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "amountMicros": "A String", # The amount of the fund.
+ "currency": "A String", # The currency in which the fund was made.
+ "userComment": "A String", # The comment added by the user to this fan funding event.
+ },
+ "giftMembershipReceivedDetails": { # Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'.
+ "associatedMembershipGiftingMessageId": "A String", # The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.
+ "gifterChannelId": "A String", # The ID of the user that made the membership gifting purchase. This matches the `snippet.authorChannelId` of the associated membership gifting message.
+ "memberLevelName": "A String", # The name of the Level at which the viewer is a member. This matches the `snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
+ },
+ "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
+ "liveChatId": "A String",
+ "memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'.
+ "memberLevelName": "A String", # The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
+ "memberMonth": 42, # The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.
+ "userComment": "A String", # The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.
+ },
+ "membershipGiftingDetails": { # Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'.
+ "giftMembershipsCount": 42, # The number of gift memberships purchased by the user.
+ "giftMembershipsLevelName": "A String", # The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
+ },
+ "messageDeletedDetails": {
+ "deletedMessageId": "A String",
+ },
+ "messageRetractedDetails": {
+ "retractedMessageId": "A String",
+ },
+ "newSponsorDetails": { # Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that "member" is the new term for "sponsor".
+ "isUpgrade": True or False, # If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.
+ "memberLevelName": "A String", # The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
+ },
+ "pollDetails": { # Details about the poll event, this is only set if the type is 'pollEvent'.
+ "metadata": {
+ "options": [ # The options will be returned in the order that is displayed in 1P
+ {
+ "optionText": "A String",
+ "tally": "A String",
+ },
+ ],
+ "questionText": "A String",
+ },
+ "status": "A String",
+ },
+ "publishedAt": "A String", # The date and time when the message was orignally published.
+ "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
+ "currency": "A String", # The currency in which the purchase was made.
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ "userComment": "A String", # The comment added by the user to this Super Chat event.
+ },
+ "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
+ "currency": "A String", # The currency in which the purchase was made.
+ "superStickerMetadata": { # Information about the Super Sticker.
+ "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it.
+ "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
+ "stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker.
+ },
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ },
+ "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
+ "messageText": "A String", # The user's message.
+ },
+ "type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
+ "userBannedDetails": {
+ "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
+ "banType": "A String", # The type of ban.
+ "bannedUserDetails": { # The details of the user that was banned.
+ "channelId": "A String", # The YouTube channel ID.
+ "channelUrl": "A String", # The channel's URL.
+ "displayName": "A String", # The channel's display name.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ },
+ },
+ },
+}
+
+